> ## Documentation Index
> Fetch the complete documentation index at: https://credira.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome to Credira API

> Get your debt recovery process run programmatically

# Credira API Documentation

Welcome to the Credira API - the comprehensive solution for automating your debt recovery and customer communication processes. Our API enables you to programmatically manage calls, emails, and customer interactions with intelligent voice agents.

<Note>
  Credira API provides powerful automation tools for debt recovery, customer
  communication, and payment processing through intelligent voice agents and
  email systems.
</Note>

## What is Credira?

Credira is an AI-powered debt recovery platform that automates customer communication through intelligent voice agents and email systems. Our API allows you to:

* **Automate debt collection calls** with AI voice agents
* **Send personalized emails** with dynamic templates
* **Track customer interactions** and payment responses
* **Manage callouts and campaigns** programmatically
* **Monitor success rates** and optimize recovery strategies

## Quick Start

<Steps>
  <Step title="Get Your API Key">
    Sign up for a Credira account and obtain your API key from the dashboard. Your API key is required for all API requests.
  </Step>

  <Step title="Choose Your Integration">
    Select the integration method that works best for your system:

    * **Direct API Integration** - Use our REST API endpoints
    * **Webhook Integration** - Receive real-time updates
    * **SDK Integration** - Use our official SDKs
  </Step>

  <Step title="Make Your First Call">
    Use the Create Call endpoint to initiate your first automated debt recovery call:

    ```bash theme={null}
    curl --request POST \
         --url https://api.credira.com/v1/calls \
         --header 'Authorization: Bearer YOUR_API_KEY' \
         --header 'Content-Type: application/json' \
         --data '{
           "phone_number": "+1234567890",
           "invoice_id": "inv_123456",
           "voice_agent_id": "agent_456789"
         }'
    ```
  </Step>

  <Step title="Monitor Results">
    Track call outcomes, customer responses, and payment status through our comprehensive reporting dashboard.
  </Step>
</Steps>

## Authentication

All API requests require authentication using your API key. Include your API key in the Authorization header:

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
```

<Warning>
  Keep your API key secure and never expose it in client-side code. Use
  environment variables or secure configuration management.
</Warning>

## Base URL

All API requests are made to our base URL:

```
https://api.credira.com/v1
```

## Rate Limits

* **Standard Plan**: 1,000 requests per hour
* **Professional Plan**: 10,000 requests per hour
* **Enterprise Plan**: 100,000 requests per hour

Rate limit headers are included in all responses:

* `X-RateLimit-Limit`: Maximum requests allowed
* `X-RateLimit-Remaining`: Requests remaining in current window
* `X-RateLimit-Reset`: Time when the rate limit resets

## Response Format

All API responses follow a consistent JSON format:

```json theme={null}
{
  "success": true,
  "data": {
    // Response data here
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}
```

## Error Handling

The API uses standard HTTP status codes and returns detailed error information:

```json theme={null}
{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Missing required parameter: phone_number"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}
```

## Common Status Codes

<ResponseField name="200" type="integer">
  Success - Request completed successfully
</ResponseField>

<ResponseField name="400" type="integer">
  Bad Request - Invalid request parameters
</ResponseField>

<ResponseField name="401" type="integer">
  Unauthorized - Invalid or missing API key
</ResponseField>

<ResponseField name="404" type="integer">
  Not Found - Resource not found
</ResponseField>

<ResponseField name="429" type="integer">
  Too Many Requests - Rate limit exceeded
</ResponseField>

<ResponseField name="500" type="integer">
  Internal Server Error - Server error occurred
</ResponseField>

## SDKs and Libraries

We provide official SDKs for popular programming languages:

<CodeGroup>
  ```javascript JavaScript theme={null}
  npm install @credira/api-client

  import { CrediraClient } from '@credira/api-client';

  const client = new CrediraClient({
    apiKey: 'your-api-key'
  });

  const call = await client.calls.create({
    phoneNumber: '+1234567890',
    invoiceId: 'inv_123456',
    voiceAgentId: 'agent_456789'
  });
  ```

  ```python Python theme={null}
  pip install credira-api

  from credira import CrediraClient

  client = CrediraClient(api_key='your-api-key')

  call = client.calls.create(
      phone_number='+1234567890',
      invoice_id='inv_123456',
      voice_agent_id='agent_456789'
  )
  ```

  ```php PHP theme={null}
  composer require credira/api-client

  use Credira\ApiClient;

  $client = new ApiClient('your-api-key');

  $call = $client->calls->create([
      'phone_number' => '+1234567890',
      'invoice_id' => 'inv_123456',
      'voice_agent_id' => 'agent_456789'
  ]);
  ```
</CodeGroup>

## Webhooks

Receive real-time notifications about call outcomes, email delivery status, and customer interactions:

```json theme={null}
{
  "event": "call.completed",
  "data": {
    "call_id": "call_123456789",
    "status": "completed",
    "duration": 180,
    "outcome": "payment_scheduled"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}
```

## Support

Need help? We're here to assist you:

* **Documentation**: Browse our comprehensive API reference
* **Support Email**: [support@credira.com](mailto:support@credira.com)
* **Status Page**: Check our system status at status.credira.com
* **Community**: Join our developer community for tips and best practices

<Tip>
  Start with our Quick Start guide to get up and running in minutes, then
  explore the full API reference for advanced features.
</Tip>