Skip to Content
APIResourcesProviders

Providers

Discover saved image and video provider connections.

Base URL: https://app.gavana.ai/api/canvas-agent/v1 · Authentication: HTTP bearer, token format cba_<token-id>.<secret>

Operations

OperationPurposeScopes
GET /providersList saved image and video provider connectionsimage:generate?, video:generate?

GET /providers

List saved image and video provider connections

  • Operation id: listProviders
  • Scopes: Requires at least one of image:generate or video:generate.
  • CLI equivalent: gavana provider list

Parameters

ParameterInTypeRequiredNotes
limitqueryintegerNoMaximum number of items in this page. min 1, max 100.
cursorquerystringNoOpaque continuation cursor from page.nextCursor. Reuse it with the same list filters. max length 8192.

Responses

StatusPayloadMeaning
200objectSaved image-provider connections with masked credentials.
defaultErrorResponseA stable machine-readable error. The response always includes X-Request-ID.

200 response body

FieldTypeRequiredNotes
connectionsarray of ProviderConnectionYes—
connections[].idstringYesPattern ^[A-Za-z0-9_-]{1,180}$.
connections[].providerstringYesOne of openai, google/nano-banana, black-forest-labs, recraft, ideogram, qwen, openrouter.
connections[].namestringYes—
connections[].maskedKeystringYes—
connections[].modelsarray of stringYes—
pageCursorPageYes—
page.limitintegerYesmin 1, max 200.
page.hasMorebooleanYes—
page.nextCursorstring | nullYesmax length 8192.

Example

curl "https://app.gavana.ai/api/canvas-agent/v1/providers" \ -H "Authorization: Bearer $GAVANA_AGENT_TOKEN"

Errors

Every failure uses the shared error envelope described in Errors and X-Request-ID. The response always carries X-Request-ID; share that value with support instead of the request payload.

Last updated on