API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Auth

Authentication and authorization information.

Get Authentication Info

client.auth.retrieveInfo(RequestOptionsoptions?): AuthRetrieveInfoResponse { apiKey, type }

GET/auth/info

ModelsExpand Collapse

AuthRetrieveInfoResponse { apiKey, type }

apiKey: APIKey { created, issuing_user, name, 2 more }

Information about the API key credentials

created: string

When the client credentials were created

formatdate-time

issuing_user: IssuingUser { id, email, name }

Information about the user who created the credentials

id: string

The user ID

email: string

The user's email

formatemail

name: string

The user's name

name: string

The name of the credential

project: Project { id, name, plan_type }

Information about the project

id: string

The project ID

name: string

The name of the project

plan_type: string

The plan type for the project

public_key: string

The public key of the client credentials

type: "apiKey"

The type of authentication being used