> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognee.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 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)
- **maxCompletionTokens** (Optional[int]): Upper bound on tokens generated for the
  completion.
- **user** (Optional[str]): OpenAI-compatible end-user identifier passed in the
  request body.

## 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



## OpenAPI

````yaml /cognee_openapi_spec.json post /api/v1/responses/
openapi: 3.1.0
info:
  title: Cognee API
  description: Cognee API with Bearer token and Cookie auth
  version: 1.0.0
servers:
  - url: https://{tenant}.aws.cognee.ai
    description: 'Cognee Cloud: your tenant pod, named in the platform.cognee.ai dashboard'
    variables:
      tenant:
        default: your-tenant
        description: Your tenant name, shown in the Cognee Cloud dashboard
  - url: http://localhost:8000
    description: 'Self-hosted: a locally running cognee server'
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: activity
    description: >-
      Activity endpoints for inspecting pipeline runs, traced spans, tenant
      users, agents, and dataset exports.
  - name: add
    description: Data ingestion endpoints for adding text, files, and structured data.
  - name: agent connections
    description: >-
      Endpoints for registering, unregistering, and inspecting agent connections
      to the instance.
  - name: agent management
    description: Endpoints for creating, listing, retrieving, and deleting agents.
  - name: auth
    description: >-
      Authentication endpoints for user registration, login, and token
      management.
  - name: checks
    description: >-
      Diagnostic endpoint for validating a Cognee Cloud API key supplied in the
      X-Api-Key header.
  - name: cognify
    description: >-
      Knowledge processing endpoints to transform raw data into knowledge
      graphs.
  - name: configuration
    description: >-
      Endpoints for storing, retrieving, and listing a user's saved
      configurations.
  - name: datasets
    description: Dataset management endpoints for listing, creating, and deleting datasets.
  - name: delete
    description: Data deletion endpoints (deprecated — use datasets endpoints instead).
  - name: forget
    description: Endpoint for removing data from the knowledge graph.
  - name: health
    description: Liveness, readiness, and component health checks.
  - name: improve
    description: Endpoint for enriching and improving an existing knowledge graph.
  - name: integrations
    description: >-
      Endpoints for connecting, provisioning, and disconnecting OAuth providers
      and plugins.
  - name: llm
    description: >-
      LLM-backed endpoints for inferring graph schemas and generating custom
      extraction prompts.
  - name: memify
    description: >-
      Endpoint for running enrichment pipelines over existing graphs or supplied
      data.
  - name: ontologies
    description: >-
      Endpoints for uploading, listing, and deleting ontology files used during
      cognify.
  - name: permissions
    description: Permission management for multi-user access control.
  - name: recall
    description: >-
      Endpoints for querying the knowledge graph and reviewing past recall
      history.
  - name: remember
    description: >-
      Endpoints for ingesting data into the knowledge graph and storing session
      memory entries.
  - name: responses
    description: Response generation endpoints using the knowledge graph.
  - name: schema
    description: >-
      Schema inspection endpoints for a dataset's derived schema inventory and
      the caller-wide memory provenance graph.
  - name: search
    description: Search endpoints for querying the knowledge graph.
  - name: sessions
    description: >-
      Endpoints for listing sessions and reporting usage, cost, and token
      statistics.
  - name: settings
    description: Configuration endpoints for managing Cognee settings.
  - name: skills
    description: >-
      Skill management endpoints for ingesting, listing, retrieving, and
      deleting dataset skills, plus read-only retrieval of improvement
      proposals.
  - name: slack
    description: >-
      Endpoints for listing workspace channels, setting channel allowlists, and
      linking Slack accounts.
  - name: sync
    description: Endpoints for syncing local data to Cognee Cloud and checking sync status.
  - name: update
    description: Endpoint for updating existing data in a dataset.
  - name: users
    description: User management endpoints.
  - name: validate
    description: >-
      Diagnostic endpoint for checking consistency between a dataset's graph and
      vector stores.
  - name: visualize
    description: Graph visualization endpoints.
paths:
  /api/v1/responses/:
    post:
      tags:
        - responses
      summary: Create Response
      description: >-
        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)

        - **maxCompletionTokens** (Optional[int]): Upper bound on tokens
        generated for the
          completion.
        - **user** (Optional[str]): OpenAI-compatible end-user identifier passed
        in the
          request body.

        ## 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
      operationId: create_response_api_v1_responses__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResponseRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    ResponseRequest:
      properties:
        model:
          $ref: '#/components/schemas/CogneeModel'
          default: cognee-v1
        input:
          type: string
          title: Input
        tools:
          anyOf:
            - items:
                $ref: '#/components/schemas/ToolFunction'
              type: array
            - type: 'null'
          title: Tools
        toolChoice:
          anyOf:
            - type: string
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Toolchoice
          default: auto
        user:
          anyOf:
            - type: string
            - type: 'null'
          title: User
        temperature:
          anyOf:
            - type: number
            - type: 'null'
          title: Temperature
          default: 1
        maxCompletionTokens:
          anyOf:
            - type: integer
            - type: 'null'
          title: Maxcompletiontokens
      type: object
      required:
        - input
      title: ResponseRequest
      description: >-
        Request body for the new responses endpoint (OpenAI Responses API
        format)
    ResponseBody:
      properties:
        id:
          type: string
          title: Id
        created:
          type: integer
          title: Created
        model:
          type: string
          title: Model
        object:
          type: string
          title: Object
          default: response
        status:
          type: string
          title: Status
          default: completed
        toolCalls:
          items:
            $ref: '#/components/schemas/ResponseToolCall'
          type: array
          title: Toolcalls
        usage:
          anyOf:
            - $ref: '#/components/schemas/ChatUsage'
            - type: 'null'
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      type: object
      required:
        - model
        - toolCalls
      title: ResponseBody
      description: Response body for the new responses endpoint
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CogneeModel:
      type: string
      enum:
        - cognee-v1
      title: CogneeModel
      description: Enum for supported model types
    ToolFunction:
      properties:
        type:
          type: string
          title: Type
          default: function
        function:
          $ref: '#/components/schemas/Function'
      type: object
      required:
        - function
      title: ToolFunction
      description: Tool function wrapper (for OpenAI compatibility)
    ResponseToolCall:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          title: Type
          default: function
        function:
          $ref: '#/components/schemas/FunctionCall'
        output:
          anyOf:
            - $ref: '#/components/schemas/ToolCallOutput'
            - type: 'null'
      type: object
      required:
        - function
      title: ResponseToolCall
      description: Tool call in a response
    ChatUsage:
      properties:
        prompt_tokens:
          type: integer
          title: Prompt Tokens
          default: 0
        completion_tokens:
          type: integer
          title: Completion Tokens
          default: 0
        total_tokens:
          type: integer
          title: Total Tokens
          default: 0
      type: object
      title: ChatUsage
      description: Token usage information
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    Function:
      properties:
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        parameters:
          $ref: '#/components/schemas/FunctionParameters'
      type: object
      required:
        - name
        - description
        - parameters
      title: Function
      description: Function definition compatible with OpenAI's format
    FunctionCall:
      properties:
        name:
          type: string
          title: Name
        arguments:
          type: string
          title: Arguments
      type: object
      required:
        - name
        - arguments
      title: FunctionCall
      description: Function call made by the assistant
    ToolCallOutput:
      properties:
        status:
          type: string
          title: Status
          default: success
        data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Data
      type: object
      title: ToolCallOutput
      description: Output of a tool call in the responses API
    FunctionParameters:
      properties:
        type:
          type: string
          title: Type
          default: object
        properties:
          additionalProperties:
            additionalProperties: true
            type: object
          type: object
          title: Properties
        required:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Required
      type: object
      required:
        - properties
      title: FunctionParameters
      description: JSON Schema for function parameters
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

````