Create a new context entry

curl --request POST \
  --url https://api.trycomp.ai/v1/context \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "question": "How do we handle user authentication in our application?",
  "answer": "We use a hybrid authentication system supporting both API keys and session-based authentication. API keys are used for programmatic access while sessions are used for web interface interactions."
}
'

{
  "id": "ctx_abc123def456",
  "organizationId": "org_xyz789uvw012",
  "question": "How do we handle user authentication in our application?",
  "answer": "We use a hybrid authentication system supporting both API keys and session-based authentication.",
  "tags": [
    "authentication",
    "security",
    "api",
    "sessions"
  ],
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "authType": "apikey"
}

{
  "message": [
    "question should not be empty",
    "answer should not be empty"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

{
  "message": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Organization not found",
  "statusCode": 404
}

{
  "message": "Internal server error",
  "statusCode": 500
}

POST

context

curl --request POST \
  --url https://api.trycomp.ai/v1/context \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "question": "How do we handle user authentication in our application?",
  "answer": "We use a hybrid authentication system supporting both API keys and session-based authentication. API keys are used for programmatic access while sessions are used for web interface interactions."
}
'

{
  "id": "ctx_abc123def456",
  "organizationId": "org_xyz789uvw012",
  "question": "How do we handle user authentication in our application?",
  "answer": "We use a hybrid authentication system supporting both API keys and session-based authentication.",
  "tags": [
    "authentication",
    "security",
    "api",
    "sessions"
  ],
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "authType": "apikey"
}

{
  "message": [
    "question should not be empty",
    "answer should not be empty"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

{
  "message": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Organization not found",
  "statusCode": 404
}

{
  "message": "Internal server error",
  "statusCode": 500
}

Authorizations

X-API-Key

string

header

required

API key for authentication

Body

application/json

Context entry data

question

string

required

The question or topic this context entry addresses

Example:

"How do we handle user authentication in our application?"

answer

string

required

The answer or detailed explanation for the question

Example:

"We use a hybrid authentication system supporting both API keys and session-based authentication. API keys are used for programmatic access while sessions are used for web interface interactions."

Response

Context entry created successfully

string

organizationId

string

question

string

answer

string

Overview

Reference

Create a new context entry | Comp AI API

Authorizations

Body

Response