Skip to main content
GET
/
api
/
documents
/
by-filename
TypeScript SDK
import { Orchata } from '@orchata-ai/sdk';

const client = new Orchata({ apiKey: 'oai_your_api_key' });

const doc = await client.documents.getByFilename({
  spaceId: 'space_123',
  filename: 'to-do.md'
});

console.log(doc.content);
{
  "id": "<string>",
  "filename": "<string>",
  "status": "<string>",
  "metadata": {},
  "content": "<string>",
  "mimeType": "<string>",
  "fileSize": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Oai-Api-Key
string
header
required

Query Parameters

spaceId
string
required

The ID of the space containing the document

Example:

"space_123"

filename
string
required

The filename to search for

Example:

"my-notes.md"

Response

Successfully retrieved document

id
string
required
filename
string
required
status
string
required
metadata
object
required
content
string
required
mimeType
string
required
fileSize
string
required
createdAt
string
required
updatedAt
string
required