Skip to content
AIDE AI Partner API

Revoke the key that makes this request

POST
/v1/api_key/revoke
curl --request POST \
  --url https://api.learningaide.ai/v1/api_key/revoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object

Example generated

{}

Responses

Section titled “Responses”

200

Section titled “200”

The request succeeded.

Media typeapplication/json
object
object
required
string
Allowed value: api_key
revoked
required
boolean

Example 

{
  "object": "api_key",
  "revoked": true
}

Headers

Section titled “Headers”
X-Request-Id
required
string

This request’s ID. Quote it when you contact support.

default

Section titled “default”

An error (client docs, “Errors”).

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error billing_error permission_error rate_limit_error api_error
code
required
string
Allowed values: parameter_missing parameter_invalid parameter_unknown invalid_json idempotency_key_missing api_key_missing api_key_invalid api_key_revoked insufficient_credits credits_expired insufficient_scope ip_not_allowed account_suspended resource_missing route_not_found idempotency_key_reused idempotency_request_in_progress external_id_taken paper_not_ready paper_not_awaiting_review paper_in_progress paper_has_empty_question review_link_unavailable file_already_attached file_purpose_mismatch file_not_uploaded file_expired submission_exists submission_not_cancelable submission_not_releasable submission_in_progress result_not_available report_not_available too_many_webhook_endpoints request_too_large unsupported_media_type rate_limit_exceeded internal_error service_unavailable
message
required
string
param
required
Any of:
string
resource_id
required
Any of:
string
request_id
required
Any of:
string

Example 

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_missing"
  }
}

Headers

Section titled “Headers”
X-Request-Id
required
string

This request’s ID. Quote it when you contact support.

Retry-After
integer

Seconds to wait before asking again.