Get Source Record Sources

curl -X GET "https://commodityai.app/api/v1/sources/123e4567-e89b-12d3-a456-426614174000/records/550e8400-e29b-41d4-a716-446655440000/sources" \
  -H "Authorization: Bearer cai_live_your_api_key_here"

{
  "data": {
    "documents": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "filename": "invoice_pages_1-3.pdf",
        "mime_type": "application/pdf",
        "size": 245000,
        "page_start": 1,
        "page_end": 3,
        "classification": "invoices",
        "uploaded_at": "2024-01-15T10:30:00Z",
        "download_url": "https://storage.example.com/signed/...",
        "download_url_expires_at": "2024-01-15T11:30:00Z",
        "is_primary": true
      },
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "filename": "invoice_pages_4-5.pdf",
        "mime_type": "application/pdf",
        "size": 180000,
        "page_start": 4,
        "page_end": 5,
        "classification": "invoices",
        "uploaded_at": "2024-01-15T10:30:00Z",
        "download_url": "https://storage.example.com/signed/...",
        "download_url_expires_at": "2024-01-15T11:30:00Z",
        "is_primary": false
      }
    ],
    "files": [
      {
        "id": "770e8400-e29b-41d4-a716-446655440002",
        "filename": "invoice_packet.pdf",
        "mime_type": "application/pdf",
        "size": 1245000,
        "page_count": 10,
        "download_url": "https://storage.example.com/signed/...",
        "download_url_expires_at": "2024-01-15T11:30:00Z"
      }
    ]
  }
}

GET

https://commodityai.app

api

sources

{id}

records

{recordId}

sources

curl -X GET "https://commodityai.app/api/v1/sources/123e4567-e89b-12d3-a456-426614174000/records/550e8400-e29b-41d4-a716-446655440000/sources" \
  -H "Authorization: Bearer cai_live_your_api_key_here"

{
  "data": {
    "documents": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "filename": "invoice_pages_1-3.pdf",
        "mime_type": "application/pdf",
        "size": 245000,
        "page_start": 1,
        "page_end": 3,
        "classification": "invoices",
        "uploaded_at": "2024-01-15T10:30:00Z",
        "download_url": "https://storage.example.com/signed/...",
        "download_url_expires_at": "2024-01-15T11:30:00Z",
        "is_primary": true
      },
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "filename": "invoice_pages_4-5.pdf",
        "mime_type": "application/pdf",
        "size": 180000,
        "page_start": 4,
        "page_end": 5,
        "classification": "invoices",
        "uploaded_at": "2024-01-15T10:30:00Z",
        "download_url": "https://storage.example.com/signed/...",
        "download_url_expires_at": "2024-01-15T11:30:00Z",
        "is_primary": false
      }
    ],
    "files": [
      {
        "id": "770e8400-e29b-41d4-a716-446655440002",
        "filename": "invoice_packet.pdf",
        "mime_type": "application/pdf",
        "size": 1245000,
        "page_count": 10,
        "download_url": "https://storage.example.com/signed/...",
        "download_url_expires_at": "2024-01-15T11:30:00Z"
      }
    ]
  }
}

Returns the source documents and files associated with a source record, including signed download URLs with a 1-hour expiry. Useful for downloading the original documents that a record was extracted from.

Path Parameters

string

required

The unique identifier (UUID) of the source record definition

recordId

string

required

The unique identifier (UUID) of the source record

Request Examples

curl -X GET "https://commodityai.app/api/v1/sources/123e4567-e89b-12d3-a456-426614174000/records/550e8400-e29b-41d4-a716-446655440000/sources" \
  -H "Authorization: Bearer cai_live_your_api_key_here"

Response

{
  "data": {
    "documents": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "filename": "invoice_pages_1-3.pdf",
        "mime_type": "application/pdf",
        "size": 245000,
        "page_start": 1,
        "page_end": 3,
        "classification": "invoices",
        "uploaded_at": "2024-01-15T10:30:00Z",
        "download_url": "https://storage.example.com/signed/...",
        "download_url_expires_at": "2024-01-15T11:30:00Z",
        "is_primary": true
      },
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "filename": "invoice_pages_4-5.pdf",
        "mime_type": "application/pdf",
        "size": 180000,
        "page_start": 4,
        "page_end": 5,
        "classification": "invoices",
        "uploaded_at": "2024-01-15T10:30:00Z",
        "download_url": "https://storage.example.com/signed/...",
        "download_url_expires_at": "2024-01-15T11:30:00Z",
        "is_primary": false
      }
    ],
    "files": [
      {
        "id": "770e8400-e29b-41d4-a716-446655440002",
        "filename": "invoice_packet.pdf",
        "mime_type": "application/pdf",
        "size": 1245000,
        "page_count": 10,
        "download_url": "https://storage.example.com/signed/...",
        "download_url_expires_at": "2024-01-15T11:30:00Z"
      }
    ]
  }
}

Response Fields

data

object

Container for documents and files

Show data

documents

array

Array of document objects extracted from the source record’s ingestion

Show document

string

Unique identifier for the document (UUID)

filename

string

Original filename of the document

mime_type

string

MIME type of the document (e.g., application/pdf, image/png)

size

number

File size in bytes

page_start

number

Starting page number within the original file (1-indexed). null for non-paginated documents.

page_end

number

Ending page number within the original file (inclusive). null for non-paginated documents.

classification

string

The source definition name the document was classified as, or null for unclassified documents

uploaded_at

string

ISO 8601 timestamp when the document was uploaded

download_url

string

Signed URL for downloading the document. Valid for 1 hour. null if URL generation failed.

download_url_expires_at

string

ISO 8601 timestamp when the download URL expires. null if no URL was generated.

is_primary

boolean

Whether this is the primary document for the record — the document that contributed the most extracted fields

files

array

Array of original file objects from the ingestion

Show file

string

Unique identifier for the file (UUID)

filename

string

Original filename of the uploaded file

mime_type

string

MIME type of the file

size

number

File size in bytes

page_count

number

Total number of pages in the file. null if page count is unavailable.

download_url

string

Signed URL for downloading the file. Valid for 1 hour. null if URL generation failed.

download_url_expires_at

string

ISO 8601 timestamp when the download URL expires. null if no URL was generated.

Documents vs Files: A file is the original uploaded document (e.g., a 10-page PDF). A document is a page range extracted from a file during processing (e.g., pages 1-3 classified as an invoice). A single file may produce multiple documents.

Response Headers

All successful responses include rate limit headers to help you monitor your API usage:

X-RateLimit-Limit-Minute

number

Maximum number of requests allowed per minute (100)

X-RateLimit-Remaining-Minute

number

Number of requests remaining in the current minute

X-RateLimit-Reset-Minute

number

Unix timestamp (in seconds) when the per-minute limit resets

X-RateLimit-Limit-Day

number

Maximum number of requests allowed per day (10,000)

X-RateLimit-Remaining-Day

number

Number of requests remaining in the current day

X-RateLimit-Reset-Day

number

Unix timestamp (in seconds) when the daily limit resets

For more information on rate limits and how to handle them, see Rate Limits.

Error Codes

Status	Code	Description
`401`	`unauthorized`	Invalid or missing API key
`404`	`not_found`	Source record definition or record not found
`429`	`rate_limit_exceeded`	Too many requests (see Rate Limits)
`500`	`internal_error`	Internal server error

Update Object Record Get Object Record Sources

Authentication

Definitions

Documents

Records

Issues

Limits & Errors

Path Parameters

Request Examples

Response

Response Fields

Response Headers

Error Codes

Authentication

Definitions

Documents

Records

Issues

Limits & Errors

​Path Parameters

​Request Examples

​Response

​Response Fields

​Response Headers

​Error Codes

Path Parameters

Request Examples

Response

Response Fields

Response Headers

Error Codes