Developer

API Documentation

Build powerful integrations with ContextFile.ai. Access your context files, skills, and tasks programmatically using our REST API.

Quick Links

API Keys

Create and manage API keys for server-side authentication.

OAuth 2.0

Build apps that integrate with user accounts via OAuth.

Webhooks

Receive real-time notifications when events occur.

Base URL

https://contextfile.ai

All API endpoints are relative to this base URL.

Authentication

ContextFile.ai supports three authentication methods. Choose the one that best fits your use case.

API Key

Simple bearer token authentication for server-to-server requests

Token prefix: cf_

OAuth 2.0

Industry-standard authorization for third-party applications

Token prefix: cf_at_

Session

Cookie-based authentication for browser requests

Token prefix: N/A

Authentication Header

Authorization: Bearer YOUR_TOKEN

API Endpoints

GET/api/v1/contextsList all context files

GET/api/v1/contexts/:idGet a specific context file

POST/api/v1/contextsCreate a new context file

PATCH/api/v1/contexts/:idUpdate a context file

DELETE/api/v1/contexts/:idDelete a context file

Example Requests

List Context Files

curl https://contextfile.ai/api/v1/contexts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Create a Context File

curl -X POST https://contextfile.ai/api/v1/contexts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Context",
    "content": "Your context content here...",
    "description": "Optional description"
  }'

Execute a Skill

curl -X POST https://contextfile.ai/api/v1/skills/SKILL_ID/execute \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "Your input prompt",
    "variables": { "key": "value" }
  }'

Response Format

Success Response

{
  "data": { ... },
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 20
  }
}

Error Response

{
  "error": "error_code",
  "message": "Human readable message"
}

Error Codes

400Bad RequestInvalid request parameters

401UnauthorizedMissing or invalid authentication

403ForbiddenInsufficient permissions or scope

404Not FoundResource does not exist

429Rate LimitedToo many requests, slow down

500Server ErrorInternal server error

Rate Limiting

API requests are rate limited to ensure fair usage. Limits vary by plan:

100

requests/hour

Free

1,000

requests/hour

Pro

10,000

requests/hour

Enterprise

Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

SDKs & Libraries

JavaScript / TypeScript

npm install @contextfile/sdk

Coming Soon

REST API

Use any HTTP client to interact with our REST API. Works with curl, fetch, axios, and more.

Available Now

API Integration Tips

Use API keys for server-side integrations, OAuth for user-facing apps
Always include proper error handling for API responses
Implement exponential backoff for rate limit errors (429)
Cache responses when appropriate to reduce API calls
Use pagination for list endpoints to handle large datasets
Store tokens securely and never expose them in client-side code

Ready to start building?

Get API Key Create OAuth App OAuth Docs

Authentication

ContextFile.ai supports three authentication methods. Choose the one that best fits your use case.

API Key

Simple bearer token authentication for server-to-server requests

Token prefix: cf_

OAuth 2.0

Industry-standard authorization for third-party applications

Token prefix: cf_at_

Session

Cookie-based authentication for browser requests

Token prefix: N/A

Authentication Header

Authorization: Bearer YOUR_TOKEN

Example Requests

List Context Files

curl https://contextfile.ai/api/v1/contexts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Create a Context File

curl -X POST https://contextfile.ai/api/v1/contexts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Context",
    "content": "Your context content here...",
    "description": "Optional description"
  }'

Execute a Skill

curl -X POST https://contextfile.ai/api/v1/skills/SKILL_ID/execute \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "Your input prompt",
    "variables": { "key": "value" }
  }'