Tickets

Create tickets, read their status and add comments (REST API v1).

Criar um ticket

POST /api/v1/tickets

Creates a ticket in the tenant bound to the API key. Send an Idempotency-Key header so retries don’t create duplicates: a repeated key returns the original result with action: deduplicated.

Autenticação: Chave API: Authorization: Bearer nhk.<keyid>.<secret>, ou chave API em X-NH-API-Key

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`Idempotency-Key`	cabeçalho	string	não	Unique key per logical operation (UUID recommended). A retry with the same key returns the first result.

Corpo do pedido

application/json

Nome	Tipo	Obrigatório	Descrição
`subject`	string	não	Ticket title. Required (alias: `summary`).
`summary`	string	não	descontinuado Alias of `subject`.
`description`	string	não	Body text (alias: `body`).
`priority`	string	não	Priority name. The tenant’s priority scheme may define more values.
`category`	string	não	Category hint used by routing.
`issuetype`	string	não	Issue-type override, for example `IT-INC` or `IT-SR`.
`country`	string	não	ISO 3166-1 alpha-2 country, if your tenant routes by country.
`sender_email`	string (email)	não	Requester. Defaults to the key’s contact.
`sender_name`	string	não
`sender_phone`	string	não
`company`	string	não
`external_id`	string	não	Your system’s id, kept for correlation.
`tags`	array<string>	não
`attachments`	array<object>	não	Attachments by reference (URL). Binary upload is not part of v1.
`attachments[].name`	string	sim
`attachments[].url`	string (uri)	não
`attachments[].size`	integer	não
`attachments[].mime`	string	não

{
  "subject": "Payment gateway returns HTTP 502",
  "description": "Checkout fails for all EU customers since 09:12 UTC.",
  "priority": "High",
  "category": "Application",
  "sender_email": "[email protected]",
  "sender_name": "ACME On-call",
  "external_id": "INC-88231",
  "tags": [
    "checkout",
    "eu-west"
  ]
}

Respostas

Estado	Descrição
`200`	Ticket created (or deduplicated by `Idempotency-Key`).
`400`	Invalid request.
`401`	API key missing, invalid or revoked.
`403`	Key disabled or missing the required scope.
`429`	Rate limit exceeded for this API key.
`500`	Unexpected server error. Retry with the same `Idempotency-Key`.

Exemplo 200

{
  "ok": true,
  "ticket_key": "ACME-1042",
  "ingestion_id": "ing_7f3c2a91",
  "action": "created",
  "status_url": "/api/v1/tickets/ACME-1042",
  "skipped": null,
  "backend_status": null,
  "backend_error": null,
  "error": null,
  "post_routing": null
}

Exemplo com curl

curl -X POST "https://exocortex-api.ai-exo-cortex.com/api/v1/tickets" \
  -H "Authorization: Bearer $EXO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  --data '{"subject":"Payment gateway returns HTTP 502","description":"Checkout fails for all EU customers since 09:12 UTC.","priority":"High","category":"Application","sender_email":"[email protected]","sender_name":"ACME On-call","external_id":"INC-88231","tags":["checkout","eu-west"]}'

Consultar um ticket

GET /api/v1/tickets/{key}

Returns the current status of a ticket in the API key’s tenant. Tickets of other tenants return 404.

Autenticação: Chave API: Authorization: Bearer nhk.<keyid>.<secret>, ou chave API em X-NH-API-Key

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`key`	caminho	string	sim	Ticket key.

Respostas

Estado	Descrição
`200`	Ticket found.
`401`	API key missing, invalid or revoked.
`403`	Key disabled or missing the required scope.
`404`	Ticket not found in the API key’s tenant.
`429`	Rate limit exceeded for this API key.
`500`	Unexpected server error. Retry with the same `Idempotency-Key`.

Exemplo 200

{
  "ok": true,
  "ticket": {
    "key": "ACME-1042",
    "summary": "Payment gateway returns HTTP 502",
    "status": "In Progress",
    "priority": "High",
    "assignee": "Jane Doe",
    "created": "2026-11-01T09:14:05.000Z",
    "updated": "2026-11-01T09:31:47.000Z"
  }
}

Exemplo com curl

curl -X GET "https://exocortex-api.ai-exo-cortex.com/api/v1/tickets/ACME-1042" \
  -H "Authorization: Bearer $EXO_API_KEY"

Adicionar um comentário

POST /api/v1/tickets/{key}/comment

Autenticação: Chave API: Authorization: Bearer nhk.<keyid>.<secret>, ou chave API em X-NH-API-Key

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`key`	caminho	string	sim	Ticket key.
`Idempotency-Key`	cabeçalho	string	não	Unique key per logical operation (UUID recommended). A retry with the same key returns the first result.

Corpo do pedido

application/json

Nome	Tipo	Obrigatório	Descrição
`comment`	string	não	Comment text. Required (alias: `text`).
`text`	string	não	descontinuado Alias of `comment`.
`sender_email`	string (email)	não
`sender_name`	string	não

{
  "comment": "Rollback of release 4.18.2 completed; error rate back to baseline.",
  "sender_email": "[email protected]"
}

Respostas

Estado	Descrição
`200`	Comment accepted.
`400`	Invalid request.
`401`	API key missing, invalid or revoked.
`403`	Key disabled or missing the required scope.
`404`	Ticket not found in the API key’s tenant.
`429`	Rate limit exceeded for this API key.
`500`	Unexpected server error. Retry with the same `Idempotency-Key`.

Exemplo 200

{
  "ok": true,
  "ticket_key": "ACME-1042",
  "ingestion_id": "ing_91be04d2"
}

Exemplo com curl

curl -X POST "https://exocortex-api.ai-exo-cortex.com/api/v1/tickets/ACME-1042/comment" \
  -H "Authorization: Bearer $EXO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  --data '{"comment":"Rollback of release 4.18.2 completed; error rate back to baseline.","sender_email":"[email protected]"}'

Página gerada a partir da especificação OpenAPI da API de integração, versão 1.1.0.