VOvoygr
calls

Get your identity and quota

Changed on

Returns the identity and quota for this API key, with key metadata. It is lighter than GET /v1/usage.

get/users/me

Request

  • Base URL
    https://api.voygr.tech
  • URL
    https://api.voygr.tech/users/me
  • Auth
    API key in header X-API-Key

Response

Successful Response

anchoredboolean

True when the credit lives on the account rather than on this key: quota_limit and current_usage are then markers, not a balance. Read credits_available.

api_key_idstring required
api_key_last_4string nullable required
ask_user_webhook_configuredboolean required
ask_user_webhook_urlstring nullable required
credits_availableinteger nullable

Credits you can spend now. Null when unknown.

credits_charge_per_successful_callinteger

What a charged call costs.

credits_heldinteger nullable

Credits frozen behind calls in flight. Null while calls placed through api.voygr.tech are in flight (the gateway holds them) or when unknown.

credits_hold_per_callinteger

What one call holds while it runs.

current_usageinteger required
customer_idstring required
customer_namestring required
maintenanceobject nullable

The current maintenance window, when one is set.

max_calls_per_dayinteger required

Calls this key may create per UTC day; over it, POST /calls answers 429 daily_call_ceiling_reached. Set by support, not by the key.

max_concurrent_callsinteger required

Calls this key may have in flight at once; more wait as queued.

max_concurrent_calls_ceilinginteger

The most PUT /users/me/limits accepts.

quota_limitinteger required
quota_periodstring required
statusstring required
webhook_eventsstring[]

Which webhooks the endpoint receives; ['ask_user'] until you set events.

Changes

  • 7199881ed19eRevision changes
    • breaking

      response property api_key_last_4 list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property ask_user_webhook_url list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property credits_available list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property credits_held list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property maintenance list-of-types was widened by adding types null to media type application/json of response 200

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response's property default value false was added for the status

    • info

      the response's property default value 0 was added for the status

    • info

      the response's property default value 0 was added for the status

    • info

      the response's property default value 100 was added for the status

  • 59969558f36aRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status