API reference

API reference · API

Report a request

POST/v1/requests/{id}/disputeAPI key

Flags a request this key's account made, by its x-antimatter-request-id, for the operator's review. A marketplace provider that served it is named to the operator, never to the caller. One report per request per account. Takes the read scope. A 404 while the operator has the marketplace off.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe request id.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
reasonrequiredstringAt most 1000 characters.

Example

{
  "reason": "string"
}

Answer 201

Filed.

Fields of the 201 answer
FieldTypeWhat it is
idinteger
objectstringOne of "dispute".
request_idstring
statusstringOne of "open".

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.
  • 409OpenAI shaped error.
  • 429Rate limited, or a spent budget or spend cap. The type distinguishes rate_limit_error, policy_exceeded, and spend_cap_exceeded.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter