responses

Create Response

OpenAI-compatible responses endpoint with function calling support.

This endpoint provides OpenAI-compatible API responses with integrated function calling capabilities for Cognee operations.

Request Parameters

input (str): The input text to process
model (str): The model to use for processing
tools (Optional[List[Dict]]): Available tools for function calling
tool_choice (Any): Tool selection strategy (default: “auto”)
temperature (float): Response randomness (default: 1.0)

Response

Returns an OpenAI-compatible response body with function call results.

Error Codes

400 Bad Request: Invalid request parameters
500 Internal Server Error: Error processing request

Notes

Compatible with OpenAI API format
Supports function calling with Cognee tools
Uses default tools if none provided

POST

api

responses

Create Response

curl --request POST \
  --url https://api.cognee.ai/api/v1/responses/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<string>"
}
'

import requests

url = "https://api.cognee.ai/api/v1/responses/"

payload = { "input": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "model": "<string>",
  "toolCalls": [
    {
      "function": {
        "name": "<string>",
        "arguments": "<string>"
      },
      "id": "<string>",
      "type": "function",
      "output": {
        "status": "success",
        "data": {}
      }
    }
  ],
  "id": "<string>",
  "created": 123,
  "object": "response",
  "status": "completed",
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0
  },
  "metadata": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Request body for the new responses endpoint (OpenAI Responses API format)

input

string

required

model

enum<string>

default:cognee-v1

Enum for supported model types

Available options:

cognee-v1

tools

ToolFunction · object[] | null

Show child attributes

toolChoice

default:auto

user

string | null

temperature

number | null

default:1

maxCompletionTokens

integer | null

Response

Successful Response

Response body for the new responses endpoint

model

string

required

toolCalls

ResponseToolCall · object[]

required

Show child attributes

string

created

integer

object

string

default:response

status

string

default:completed

usage

ChatUsage · object | null

Token usage information

Show child attributes

metadata

Metadata · object

⌘I

Create Response

curl --request POST \
  --url https://api.cognee.ai/api/v1/responses/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<string>"
}
'

import requests

url = "https://api.cognee.ai/api/v1/responses/"

payload = { "input": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "model": "<string>",
  "toolCalls": [
    {
      "function": {
        "name": "<string>",
        "arguments": "<string>"
      },
      "id": "<string>",
      "type": "function",
      "output": {
        "status": "success",
        "data": {}
      }
    }
  ],
  "id": "<string>",
  "created": 123,
  "object": "response",
  "status": "completed",
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0
  },
  "metadata": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}