Skip to Content
API ReferenceSources

Sources API

Endpoints for managing sources within notebooks.

Endpoints Overview

MethodEndpointDescription
GET/notebooks/:notebookId/sourcesList sources in a notebook
POST/notebooks/:notebookId/sourcesAdd a new source
GET/sources/:sourceId/statusCheck processing status
DELETE/sources/:sourceIdDelete a source

List Sources

GET /notebooks/:notebookId/sources

Returns all sources in a notebook.

Response

{
  "data": [
    {
      "id": "src_123",
      "type": "file",
      "filename": "report.pdf",
      "status": "completed",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ]
}

Add Source

POST /notebooks/:notebookId/sources

Adds a new source to a notebook.

File Upload

{
  "type": "file",
  "file": "<base64-encoded-content>",
  "filename": "document.pdf"
}

URL

{
  "type": "url",
  "url": "https://example.com/article"
}

YouTube

{
  "type": "youtube",
  "url": "https://youtube.com/watch?v=..."
}

Response

{
  "data": {
    "id": "src_456",
    "type": "file",
    "filename": "document.pdf",
    "status": "pending",
    "createdAt": "2024-01-21T09:00:00Z"
  }
}

Get Source Status

GET /sources/:sourceId/status

Check the processing status of a source.

Response

{
  "data": {
    "id": "src_789",
    "status": "completed",
    "progress": 100,
    "message": "Processing complete"
  }
}

Status Values

StatusDescription
pendingQueued for processing
processingCurrently being processed
completedReady for use
failedProcessing failed

Delete Source

DELETE /sources/:sourceId

Deletes a source from its notebook.

Response

Returns 204 No Content on success.

Errors

StatusCodeDescription
400VALIDATION_ERRORInvalid request or unsupported format
404NOT_FOUNDSource or notebook not found
413PAYLOAD_TOO_LARGEFile exceeds size limit

Learn More

Notebooks API

Manage notebooks

Conversations API

Chat with your sources

Last updated on
NotebooksConversations