VOOZH about

URL: https://platform.claude.com/docs/en/build-with-claude/citations

⇱ Citations - Claude API Docs


Citations
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

Was this page helpful?

This feature is eligible for Zero Data Retention (ZDR). When your organization has a ZDR arrangement, data sent through this feature is not stored after the API response is returned.

Claude is capable of providing detailed citations when answering questions about documents, helping you track and verify information sources in responses.

All active models support citations, with the exception of Haiku 3.

Share your feedback and suggestions about the citations feature using this form.

Here's an example of how to use citations with the Messages API:

client = anthropic.Anthropic()

response = client.messages.create(
 model="claude-opus-4-8",
 max_tokens=1024,
 messages=[
 {
 "role": "user",
 "content": [
 {
 "type": "document",
 "source": {
 "type": "text",
 "media_type": "text/plain",
 "data": "The grass is green. The sky is blue.",
 },
 "title": "My Document",
 "context": "This is a trustworthy document.",
 "citations": {"enabled": True},
 },
 {"type": "text", "text": "What color is the grass and sky?"},
 ],
 }
 ],
)
print(response)

Comparison with prompt-based approaches

In comparison with prompt-based citations solutions, the citations feature has the following advantages:

  • Cost savings: If your prompt-based approach asks Claude to output direct quotes, you may see cost savings due to the fact that cited_text does not count towards your output tokens.
  • Better citation reliability: Because citations are parsed into the respective response formats mentioned above and cited_text is extracted, citations are guaranteed to contain valid pointers to the provided documents.
  • Improved citation quality: In evaluations, the citations feature was found to be significantly more likely to cite the most relevant quotes from documents as compared to purely prompt-based approaches.

How citations work

Integrate citations with Claude in these steps:

Automatic chunking vs custom content

By default, plain text and PDF documents are automatically chunked into sentences. If you need more control over citation granularity (e.g., for bullet points or transcripts), use custom content documents instead. See Document Types for more details.

For example, if you want Claude to be able to cite specific sentences from your RAG chunks, you should put each RAG chunk into a plain text document. Otherwise, if you do not want any further chunking to be done, or if you want to customize any additional chunking, you can put RAG chunks into custom content document(s).

Citable vs non-citable content

Citation indices

Token costs

Feature compatibility

Citations works in conjunction with other API features including prompt caching, token counting and batch processing.

Citations and Structured Outputs are incompatible

Citations cannot be used together with Structured Outputs. If you enable citations on any user-provided document (Document blocks or RequestSearchResultBlock) and also include the output_config.format parameter (or the deprecated output_format parameter), the API will return a 400 error.

This is because citations require interleaving citation blocks with text output, which is incompatible with the strict JSON schema constraints of structured outputs.

Using Prompt Caching with Citations

Citations and prompt caching can be used together effectively.

The citation blocks generated in responses cannot be cached directly, but the source documents they reference can be cached. To optimize performance, apply cache_control to your top-level document content blocks.

In this example:

Document Types

Choosing a document type

Three document types are supported for citations. Documents can be provided directly in the message (base64, text, or URL) or uploaded via the Files API and referenced by file_id:

TypeBest forChunkingCitation format
Plain textSimple text documents, proseSentenceCharacter indices (0-indexed)
PDFPDF files with text contentSentencePage numbers (1-indexed)
Custom contentLists, transcripts, special formatting, more granular citationsNo additional chunkingBlock indices (0-indexed)

.csv, .xlsx, .docx, .md, and .txt files are not supported as document blocks. Convert these to plain text and include directly in message content. See Working with other file formats.

Plain text documents

Plain text documents are automatically chunked into sentences. You can provide them inline or by reference with their file_id:

PDF documents

PDF documents can be provided as base64-encoded data, a URL, or by file_id. PDF text is extracted and chunked into sentences. As image citations are not yet supported, PDFs that are scans of documents and do not contain extractable text will not be citable.

Custom content documents

Custom content documents give you control over citation granularity. No additional chunking is done and chunks are provided to the model according to the content blocks provided.

{
 "type": "document",
 "source": {
 "type": "content",
 "content": [
 {"type": "text", "text": "First chunk"},
 {"type": "text", "text": "Second chunk"},
 ],
 },
 "title": "Document Title", # optional
 "context": "Context about the document that will not be cited from", # optional
 "citations": {"enabled": True},
}

Response Structure

When citations are enabled, responses include multiple text blocks with citations:

{
 "content": [
 {"type": "text", "text": "According to the document, "},
 {
 "type": "text",
 "text": "the grass is green",
 "citations": [
 {
 "type": "char_location",
 "cited_text": "The grass is green.",
 "document_index": 0,
 "document_title": "Example Document",
 "start_char_index": 0,
 "end_char_index": 20,
 }
 ],
 },
 {"type": "text", "text": " and "},
 {
 "type": "text",
 "text": "the sky is blue",
 "citations": [
 {
 "type": "char_location",
 "cited_text": "The sky is blue.",
 "document_index": 0,
 "document_title": "Example Document",
 "start_char_index": 20,
 "end_char_index": 36,
 }
 ],
 },
 {
 "type": "text",
 "text": ". Information from page 5 states that ",
 },
 {
 "type": "text",
 "text": "water is essential",
 "citations": [
 {
 "type": "page_location",
 "cited_text": "Water is essential for life.",
 "document_index": 1,
 "document_title": "PDF Document",
 "start_page_number": 5,
 "end_page_number": 6,
 }
 ],
 },
 {
 "type": "text",
 "text": ". The custom document mentions ",
 },
 {
 "type": "text",
 "text": "important findings",
 "citations": [
 {
 "type": "content_block_location",
 "cited_text": "These are important findings.",
 "document_index": 2,
 "document_title": "Custom Content Document",
 "start_block_index": 0,
 "end_block_index": 1,
 }
 ],
 },
 ]
}

Streaming Support

For streaming responses, a citations_delta type is included that contains a single citation to be added to the citations list on the current text content block.

  1. Provide document(s) and enable citations

    • Include documents in any of the supported formats: PDFs, plain text, or custom content documents
    • Set citations.enabled=true on each of your documents. Currently, citations must be enabled on all or none of the documents within a request.
    • Note that only text citations are currently supported and image citations are not yet possible.
  2. Documents get processed

    • Document contents are "chunked" in order to define the minimum granularity of possible citations. For example, sentence chunking would allow Claude to cite a single sentence or chain together multiple consecutive sentences to cite a paragraph (or longer)!
      • For PDFs: Text is extracted as described in PDF Support and content is chunked into sentences. Citing images from PDFs is not currently supported.
      • For plain text documents: Content is chunked into sentences that can be cited from.
      • For custom content documents: Your provided content blocks are used as-is and no further chunking is done.
  3. Claude provides cited response

    • Responses may now include multiple text blocks where each text block can contain a claim that Claude is making and a list of citations that support the claim.
    • Citations reference specific locations in source documents. The format of these citations are dependent on the type of document being cited from.
      • For PDFs: Citations include the page number range (1-indexed).
      • For plain text documents: Citations include the character index range (0-indexed).
      • For custom content documents: Citations include the content block index range (0-indexed) corresponding to the original content list provided.
    • Document indices are provided to indicate the reference source and are 0-indexed according to the list of all documents in your original request.
client = anthropic.Anthropic()

# Long document content (e.g., technical documentation)
long_document = (
 "This is a very long document with thousands of words..." + " ... " * 1000
) # Minimum cacheable length

response = client.messages.create(
 model="claude-opus-4-8",
 max_tokens=1024,
 messages=[
 {
 "role": "user",
 "content": [
 {
 "type": "document",
 "source": {
 "type": "text",
 "media_type": "text/plain",
 "data": long_document,
 },
 "citations": {"enabled": True},
 "cache_control": {
 "type": "ephemeral"
 }, # Cache the document content
 },
 {
 "type": "text",
 "text": "What does this document say about API features?",
 },
 ],
 }
 ],
)
print(response)