Credentials

Credential Categories

Credentials are organized by what they connect to:

LLM Credentials

Connect to LLM providers for prompt execution and agent orchestration.

Not every provider supports every feature — see Prompts for how reasoning, web search, prompt caching, and structured output appear in prompt settings.

Speech Credentials

Connect to speech providers for text-to-speech and speech-to-text.

Image Credentials

Connect to image generation and editing providers.

Video Credentials

Connect to video generation providers.

Data Warehouse Credentials

Connect to databases for data source queries.

Tool Credentials

Credentials for external APIs and services used by MCP tools.

Python SDK

# LLM credential
credential = client.credentials.create(
    name="OpenAI Production",
    category="llm",
    type="openai",
    value="sk-proj-your-openai-api-key",
    description="Production OpenAI API key"
)
 
# Data warehouse credential
db_credential = client.credentials.create(
    name="Analytics Database",
    category="data_warehouse",
    type="postgresql",
    value="postgresql://user:password@host:5432/analytics",
    description="Read-only analytics database"
)
 
# Speech credential
speech_credential = client.credentials.create(
    name="ElevenLabs Production",
    category="speech",
    type="elevenlabs",
    value="your-elevenlabs-api-key",
    description="ElevenLabs TTS API key"
)
 
# Tool credential
tool_credential = client.credentials.create(
    name="Slack Bot Token",
    category="tools",
    type="api_key",
    value="xoxb-your-slack-bot-token",
    description="Slack bot for notifications"
)

JavaScript SDK

const credential = await client.credentials.create({
  name: 'OpenAI Production',
  category: 'llm',
  type: 'openai',
  value: 'sk-proj-your-openai-api-key',
  description: 'Production OpenAI API key',
})

Default Credentials

You can mark one credential per type as the default. Default credentials are automatically used when no specific credential is specified:

client.credentials.set_default(credential_id="your-credential-id")

When an agent or prompt references a model from a provider (e.g., OpenAI), PromptRails uses the default credential for that provider type unless overridden.

Connection Validation

Validate that a credential can successfully connect to its target service:

result = client.credentials.validate(credential_id="your-credential-id")
print(f"Valid: {result['data']['is_valid']}")

Validation checks vary by credential type:

• LLM credentials: Makes a lightweight API call to verify the key
• Database credentials: Attempts a connection and basic query
• Tool credentials: Depends on the tool configuration

Schema Discovery

For data warehouse credentials, PromptRails can discover the database schema (tables, columns, types):

# Trigger schema discovery
client.credentials.discover_schema(credential_id="your-credential-id")
 
# Get the discovered schema
credential = client.credentials.get(credential_id="your-credential-id")
if credential["data"]["has_schema"]:
    print(f"Schema updated: {credential['data']['schema_updated_at']}")

The discovered schema includes:

• Table names
• Column names and data types
• Nullability
• Default values
• Descriptions (where available)

This schema information helps agents understand the database structure when constructing queries.

Credential Response

API responses include a safe representation of credentials (never the raw value):

Updating Credentials

When you update a credential, the new value is encrypted and stored. The previous value cannot be recovered.

client.credentials.update(
    credential_id="your-credential-id",
    value="new-api-key-value",
    name="Updated Name"
)

Deleting Credentials

Credentials are soft-deleted. Deleting a credential does not affect historical execution traces but will prevent future use.

client.credentials.delete(credential_id="your-credential-id")