Upload a file - Orq.ai Documentation

POST

files

Core - Upload retrieval file

curl --request POST \
  --url 'https://api.orq.ai/v2/files' \
  --header 'Authorization: Bearer $ORQ_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filename": "support-faq.md",
    "content": "IyBTdXBwb3J0IEZBUQoKQ29tbW9uIHJlc29sdXRpb25zIGFuZCBlc2NhbGF0aW9uIHBhdGhzLg==",
    "content_type": "text/markdown",
    "purpose": "FILE_PURPOSE_RETRIEVAL",
    "project_id": "proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V"
  }'

import { Orq } from '@orq-ai/node';

const client = new Orq({
  apiKey: process.env.ORQ_API_KEY,
});

const content = Buffer.from(
  '# Support FAQ\n\nCommon resolutions and escalation paths.',
).toString('base64');

const result = await client.files.create({
  filename: 'support-faq.md',
  content,
  contentType: 'text/markdown',
  purpose: 'FILE_PURPOSE_RETRIEVAL',
  projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',
});

console.log(result.file.fileId);

import base64
import os
from orq_ai_sdk import Orq

client = Orq(api_key=os.environ["ORQ_API_KEY"])

content = base64.b64encode(
    b"# Support FAQ\n\nCommon resolutions and escalation paths."
).decode("utf-8")

result = client.files.create(
    filename="support-faq.md",
    content=content,
    content_type="text/markdown",
    purpose="FILE_PURPOSE_RETRIEVAL",
    project_id="proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V",
)

print(result.file.file_id)

{
  "file": {
    "file_id": "<string>",
    "file_name": "<string>",
    "bytes": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "project_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

filename

string

required

Name to store for the uploaded file, including extension when available.

content

string<bytes>

required

Base64-encoded file contents.

purpose

enum<string>

Intended usage category for the uploaded file. Defaults to retrieval when omitted.

Available options:

FILE_PURPOSE_UNSPECIFIED,

FILE_PURPOSE_RETRIEVAL,

FILE_PURPOSE_KNOWLEDGE_DATASOURCE,

FILE_PURPOSE_BATCH

content_type

string

MIME type of the uploaded content, for example application/pdf.

project_id

string

Project the file is created in. Optional: project-scoped API keys default to the key's bound project; workspace-scoped callers default to the workspace's default project.

Response

200 - application/json

file

object

required

Newly created file.

Show child attributes

List all files

Retrieve a file

⌘I

Core - Upload retrieval file

curl --request POST \
  --url 'https://api.orq.ai/v2/files' \
  --header 'Authorization: Bearer $ORQ_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filename": "support-faq.md",
    "content": "IyBTdXBwb3J0IEZBUQoKQ29tbW9uIHJlc29sdXRpb25zIGFuZCBlc2NhbGF0aW9uIHBhdGhzLg==",
    "content_type": "text/markdown",
    "purpose": "FILE_PURPOSE_RETRIEVAL",
    "project_id": "proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V"
  }'

import { Orq } from '@orq-ai/node';

const client = new Orq({
  apiKey: process.env.ORQ_API_KEY,
});

const content = Buffer.from(
  '# Support FAQ\n\nCommon resolutions and escalation paths.',
).toString('base64');

const result = await client.files.create({
  filename: 'support-faq.md',
  content,
  contentType: 'text/markdown',
  purpose: 'FILE_PURPOSE_RETRIEVAL',
  projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',
});

console.log(result.file.fileId);

import base64
import os
from orq_ai_sdk import Orq

client = Orq(api_key=os.environ["ORQ_API_KEY"])

content = base64.b64encode(
    b"# Support FAQ\n\nCommon resolutions and escalation paths."
).decode("utf-8")

result = client.files.create(
    filename="support-faq.md",
    content=content,
    content_type="text/markdown",
    purpose="FILE_PURPOSE_RETRIEVAL",
    project_id="proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V",
)

print(result.file.file_id)

{
  "file": {
    "file_id": "<string>",
    "file_name": "<string>",
    "bytes": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "project_id": "<string>"
  }
}