Skip to content

Use this endpoint to check the configuration and authentication status of the image generation backend for a workspace. The response indicates whether image generation is enabled, which provider and model are configured, and whether the credentials are valid.

GET /api/v1/workspaces/{workspaceID}/image-gen/status

Section titled “GET /api/v1/workspaces/{workspaceID}/image-gen/status”
NameInTypeRequiredDescription
workspaceIDpathstringYesThe ID of the workspace to query.
{
"enabled": true,
"model": "dall-e-3",
"provider": "openai",
"authenticated": true
}
const status = await client.agent.imageGen.getStatus({
workspaceID: "ws_abc123"
});
console.log(status.enabled);
console.log(status.authenticated);