api-key

Generate Api Key

Changed on

Generate an api key for the user.

post/api/v1/api-key

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/api-key
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Request body

descriptionstring
read_onlyboolean
expires_atstring date-time nullable
workspacesstring[] nullable
role_idstring uuid nullable
org_role_idstring uuid nullable
default_workspace_idstring uuid nullable

Response

Successful Response

created_atstring date-time nullable
idstring uuid required
short_keystring required
descriptionstring required
read_onlyboolean
last_used_atstring date-time nullable
expires_atstring date-time nullable
revoked_atstring date-time nullable
workspace_namesstring[] nullable
default_workspace_namestring nullable
role_idstring uuid nullable
org_role_idstring uuid nullable
access_scope'organization' | 'workspace'
created_bystring nullable
is_tracing_keyboolean
workspace_idsstring[]
can_deleteboolean

Whether tracing-key deletion authority has been confirmed. Legacy key responses do not evaluate this capability.

keystring required

Changes

  • 1a8ee9358d81Revision changes
    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      added the non-success 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

  • 6da148fb416dRevision changes
    • info

      added the optional property to the response with the status