Skip to main content
GET
/
v1
/
project
/
status
Project Status
curl --request GET \
  --url https://api.astralform.ai/v1/project/status
{
  "is_ready": true,
  "llm_configured": true,
  "llm_provider": "openai",
  "llm_model": "gpt-4o",
  "message": "Project is ready for chat."
}

Documentation Index

Fetch the complete documentation index at: https://astralform.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Check if the project has a valid LLM configuration before starting a chat. iOS clients should call this on app launch to show appropriate UI when no LLM is configured.

Response

is_ready
boolean
Whether the project is ready for chat.
llm_configured
boolean
Whether an LLM provider has been configured in the dashboard.
llm_provider
string
The configured LLM provider (e.g., "openai", "anthropic", "groq").
llm_model
string
The configured model name (e.g., "gpt-4o", "claude-sonnet-4-20250514").
message
string
Human-readable status message.
{
  "is_ready": true,
  "llm_configured": true,
  "llm_provider": "openai",
  "llm_model": "gpt-4o",
  "message": "Project is ready for chat."
}

Example

let status = try await client.getProjectStatus()

if !status.isReady {
    // Show setup required UI
    showConfigurationRequired()
}