Send a message - QX Labs Docs

POST

responses

cURL

curl https://api.qxlabs.com/v1/responses \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "builtin:qx_agent",
    "input": "Summarise my unread emails from today",
    "permission_mode": "normal"
  }'

from openai import OpenAI

client = OpenAI(base_url="https://api.qxlabs.com/v1", api_key="<YOUR_QX_API_KEY>")

response = client.responses.create(
    model="builtin:qx_agent",
    input="Summarise my unread emails from today",
    # QX's own fields go in extra_body
    extra_body={"permission_mode": "normal"},
)
print(response.output_text)

import OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.qxlabs.com/v1", apiKey: "<YOUR_QX_API_KEY>" });

// QX's own fields aren't in OpenAI's types, so a call that sends them uses this type
type Params = OpenAI.Responses.ResponseCreateParamsNonStreaming & {
  permission_mode?: "delegated" | "normal" | "auto";
  connected_accounts?: Record<string, string>;
};

const params: Params = {
  model: "builtin:qx_agent",
  input: "Summarise my unread emails from today",
  permission_mode: "normal",
};
const response = await client.responses.create(params);
console.log(response.output_text);

{
  "id": "resp_8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f_4f1a2b3c4d5e",
  "object": "response",
  "created_at": 1793714400,
  "status": "completed",
  "model": "builtin:qx_agent",
  "conversation": {
    "id": "8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f"
  },
  "output": [
    {
      "type": "mcp_call",
      "id": "mcp_toolu_01A2b3C4d5E6",
      "server_label": "gmail",
      "name": "GMAIL_FETCH_EMAILS",
      "arguments": "{}",
      "output": null,
      "error": null,
      "status": "completed",
      "approval_request_id": null
    },
    {
      "type": "message",
      "id": "msg_77c0a1b2c3d4",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "You have 3 unread emails today...",
          "annotations": []
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 5120,
    "input_tokens_details": {
      "cached_tokens": 0,
      "cache_write_tokens": 0
    },
    "output_tokens": 410,
    "output_tokens_details": {
      "reasoning_tokens": 120
    },
    "total_tokens": 5530
  },
  "error": null
}

{
  "error": {
    "message": "Send one user message. The conversation keeps the earlier ones.",
    "type": "invalid_request_error",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "I can't reply right now because your organisation is out of credits...",
    "type": "insufficient_quota",
    "param": null,
    "code": "insufficient_quota"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Your QX API key. The X-API-Key header works too

Body

application/json

model

string

required

The agent's ID, as shown in its URL in the app, or builtin:qx_agent for the QX agent

Example:

"builtin:qx_agent"

input

required

The message as text, or a list holding one user message, or a list of answers to approval requests. Answers go on the conversation that paused, with no message

Example:

"Summarise my unread emails from today"

previous_response_id

string

Continues the conversation of this response

conversation

string

Continues this conversation. Send this or previous_response_id, not both

stream

boolean

default:false

Stream the turn as server-sent events

permission_mode

enum<string>

What happens to a tool that needs approval, for this message only. delegated (the default for a message): it's refused. normal (the default for answers): the turn pauses with approval requests. auto: it runs without asking.

Available options:

delegated,

normal,

auto

connected_accounts

object

The account to use for an app on this message, as app to account ID, from the connected accounts endpoint

Show child attributes

Response

The agent's turn. With stream, a stream of Responses API events instead

string

The response's ID. Send it as previous_response_id to continue the conversation

object

string

created_at

integer

status

string

completed, failed or cancelled

model

string

conversation

object

Show child attributes

previous_response_id

string | null

The previous_response_id the request sent

output

Item · object[]

What the agent did, in order. Its thinking as reasoning items, its messages as message items, its finished tool calls as mcp_call items, and mcp_approval_request items when the turn paused

Show child attributes

usage

object | null

The turn's tokens. Null while the turn runs

Show child attributes

error

object | null

Why the turn failed. Null otherwise

Show child attributes

steered

boolean

Only when the conversation was already running a turn. The message joined that turn, which answers it

cURL

curl https://api.qxlabs.com/v1/responses \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "builtin:qx_agent",
    "input": "Summarise my unread emails from today",
    "permission_mode": "normal"
  }'

from openai import OpenAI

client = OpenAI(base_url="https://api.qxlabs.com/v1", api_key="<YOUR_QX_API_KEY>")

response = client.responses.create(
    model="builtin:qx_agent",
    input="Summarise my unread emails from today",
    # QX's own fields go in extra_body
    extra_body={"permission_mode": "normal"},
)
print(response.output_text)

import OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.qxlabs.com/v1", apiKey: "<YOUR_QX_API_KEY>" });

// QX's own fields aren't in OpenAI's types, so a call that sends them uses this type
type Params = OpenAI.Responses.ResponseCreateParamsNonStreaming & {
  permission_mode?: "delegated" | "normal" | "auto";
  connected_accounts?: Record<string, string>;
};

const params: Params = {
  model: "builtin:qx_agent",
  input: "Summarise my unread emails from today",
  permission_mode: "normal",
};
const response = await client.responses.create(params);
console.log(response.output_text);

{
  "id": "resp_8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f_4f1a2b3c4d5e",
  "object": "response",
  "created_at": 1793714400,
  "status": "completed",
  "model": "builtin:qx_agent",
  "conversation": {
    "id": "8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f"
  },
  "output": [
    {
      "type": "mcp_call",
      "id": "mcp_toolu_01A2b3C4d5E6",
      "server_label": "gmail",
      "name": "GMAIL_FETCH_EMAILS",
      "arguments": "{}",
      "output": null,
      "error": null,
      "status": "completed",
      "approval_request_id": null
    },
    {
      "type": "message",
      "id": "msg_77c0a1b2c3d4",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "You have 3 unread emails today...",
          "annotations": []
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 5120,
    "input_tokens_details": {
      "cached_tokens": 0,
      "cache_write_tokens": 0
    },
    "output_tokens": 410,
    "output_tokens_details": {
      "reasoning_tokens": 120
    },
    "total_tokens": 5530
  },
  "error": null
}

{
  "error": {
    "message": "Send one user message. The conversation keeps the earlier ones.",
    "type": "invalid_request_error",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "I can't reply right now because your organisation is out of credits...",
    "type": "insufficient_quota",
    "param": null,
    "code": "insufficient_quota"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}