---
title: "/responses"
method: POST
path: "/v1/responses"
tags: ["Responses"]
---

# /responses

`POST /v1/responses`

## Request

- Base URL: `https://api.linkup.so`
- URL: `https://api.linkup.so/v1/responses`
- Auth: HTTP bearer

Proxy endpoint for OpenAI response generation — use when the OpenAI client's base URL is set to linkup.

## Request body

- CreateResponsesInput
  - `input` union, required: The natural language question for which you want to retrieve context.
    - string
    - object[]
      - `content` string, required
      - `role` 'user' | 'assistant' | 'developer', required
  - `instructions` string: Optional instructions to guide the response generation. It`s similar to a system message.
  - `model` 'linkup-deep' | 'linkup-standard', required: The model used to generate the response.`linkup-standard` returns results faster; `linkup-deep` takes longer but yields more comprehensive results.
  - `text` ResponsesTextFormatInput
    - `format` union, required: Defines the response text format. Accepts the literal string `text` for plain text or a JSON schema object that describes the desired structured output.
      - string
      - object

## Response `200`

Successful response

- ResponsesOutputOutput
  - `created_at` number, required
  - `error` string, nullable, required
  - `id` string, required
  - `incomplete_details` unknown, required
  - `instructions` unknown, required
  - `metadata` unknown, required
  - `model` string, required
  - `object` 'response', required
  - `output` ResponsesMessageOutputOutput[], nullable, required
    - `content` ResponsesTextOutputOutput[], required
      - `annotations` ResponsesUrlCitationOutputOutput[], required
        - `end_index` number, required
        - `start_index` number, required
        - `title` string, required
        - `type` 'url_citation', required
        - `url` string, required
      - `text` string, required
      - `type` 'output_text', required
    - `id` string, required
    - `role` 'assistant', required
    - `status` 'completed', required
    - `type` 'message', required
  - `output_text` string, required
  - `parallel_tool_calls` boolean, required
  - `temperature` unknown, required
  - `tool_choice` 'auto', required
  - `tools` unknown[], required
    - unknown
  - `top_p` unknown, required

## Other responses

- `400`: Bad Request - Invalid parameters
- `401`: Unauthorized - Invalid or missing API key
- `429`: Too Many Requests - Rate limit exceeded or insufficient credits

## Changes

- **2026-11-03** `b9bcfb4b9efd`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/linkup/apis/linkup-api/changes/v1/responses/post.md)

---

[API](https://skmtc.dev/linkup/apis/linkup-api.md) - [All operations](https://skmtc.dev/linkup/apis/linkup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linkup/apis/linkup-api/revisions/b9bcfb4b9efd?raw)