API Keys

Create API key

Creates a revocable API key and returns its secret once.

post/api/v1/api-keys

Request body

namestring

Example request

{
  "name": "My API Key"
}

Response

API key created

idstring required

fullKeystring required

namestring required

prefixstring required

createdAtstring date-time required

Example response

{
  "id": "42",
  "fullKey": "xq_live_abc123def456",
  "name": "My API Key",
  "prefix": "xq_live_abc1",
  "createdAt": "2025-01-15T12:00:00Z"
}

Changes

Changed in 2 of the 19 revisions of this API.72

Aug 12, 20265d4938bb7de354See the full diff
- ●
  added the new closed enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new closed enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new expired enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new expired enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
Aug 12, 20264da209b29df818See the full diff
- ●
  added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added

Full history