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

# Developer Master Lookups Reference

> Resolve dropdown values, foreign key IDs, and system enumerations

When creating or updating entities in Valuez AI (such as Agents, Knowledge Bases, and Outbound Campaigns), the API requires specific relational IDs (e.g., `IndustryTypeID`, `AgentTypeID`, `LanguageID`, `StopRuleID`).

These IDs correspond to master lists and cannot be guessed. All lookup endpoints use the `GET` method with `x-api-key` authentication and return structured arrays of active options for your workspace.

**Production Base URL**: `https://api.dashboard.valuez.ai`

***

## 1. Lookup Execution Order

Before calling create/update endpoints, resolve IDs in this logical sequence:

```mermaid theme={null}
graph TD
    subgraph For AI Agents
        R[Region Lookup] --> TZ[Timezone Lookup]
        I[Industry Lookup] --> AT[Agent Type Lookup]
        L[Language Lookup] --> T[Tone Lookup]
        IC[Icon Lookup] --> LP[LLM / Voice / STT Lookups]
    end
    subgraph For Outbound Campaigns
        A[Agent Lookup] --> PN[Campaign Phone Numbers]
        SR[Stop Rule Lookup] --> LS[Launch Settings]
        CAT[Catalog Product/Service]
    end
```

***

## 2. Agent & System Lookups

Use these lookups to populate agent persona, voice, and language parameters:

| Lookup Entity | Method & Endpoint | Used In | Description |
| - | - | - | - |
| **Agent Types** | `GET /api/v1/external/agent/get-agent-type-lookup` | `AgentTypeID` | Customer support, Sales rep, Lead qualifier, Appointment scheduler. |
| **Languages** | `GET /api/v1/external/language/get-languageLookup` | `LanguageID` | Supported languages: English (1), Hindi (2), Marathi (3). |
| **Agent Tones** | `GET /api/v1/external/agent-tone/get-agent-tone-lookup` | `ToneID` | Conversational tones: Professional, Friendly, Empathetic, Casual. |
| **Agent Icons** | `GET /api/v1/external/icon/get-iconLookup` | `IconID` | Avatar and visual icon identifiers. |
| **Existing Agents** | `GET /api/v1/external/agent/get-agent-lookup` | `AgentID` | List of all configured agents in the workspace. |
| **LLM Providers** | `GET /api/v1/external/llm/get-llm-Lookup` | `LLMProviderID` | Available foundation models (e.g., Sarvam, OpenAI, Claude). |
| **Voice Providers** | `GET /api/v1/external/voice/get-voice-Lookup` | `VoiceProviderID` | Text-to-speech voice engines and voice IDs. |
| **STT Providers** | `GET /api/v1/external/agent-config/transcribe-provider-Lookup` | `TranscribeProviderID` | Speech-to-text recognition providers. |
| **Speech Rate Types** | `GET /api/v1/external/agent-config/speech-rate-type-lookup` | `SpeechRateID` | Speaking speeds (Slow, Normal, Fast). |
| **Conversation Modes** | `GET /api/v1/external/conv-mode/get-conv-mode-Lookup` | `ConversationalModeIDs` | Voice call, Chat widget, Hybrid. |

### Sample Lookup Response:

```json theme={null}
{
  "statusCode": 200,
  "data": [
    { "id": 1, "name": "English", "code": "en" },
    { "id": 2, "name": "Hindi", "code": "hi" },
    { "id": 3, "name": "Marathi", "code": "mr" }
  ]
}
```

***

## 3. Organization & Regional Lookups

| Lookup Entity | Method & Endpoint | Used In | Description |
| - | - | - | - |
| **Industries** | `GET /api/v1/external/industry/get-industryLookup` | `IndustryTypeID` | Agriculture, Healthcare, Real Estate, IT, Finance, Retail. |
| **Regions** | `GET /api/v1/external/region/get-regionLookup` | `RegionTypeID` | Geographic operating regions (India, North America, Global). |
| **Time Zones** | `GET /api/v1/external/timezone/get-timezoneLookup` | `TimeZoneID` | Operating schedules (e.g., `Asia/Kolkata`, `America/New_York`). |
| **Price Units** | `GET /api/v1/external/price-unit/get-price-unit-lookup` | `PriceUnitID` | Currencies and pricing units (INR, USD). |

***

## 4. Knowledge Base Lookups

| Lookup Entity | Method & Endpoint | Used In | Description |
| - | - | - | - |
| **Knowledge Bases** | `GET /api/v1/external/kb/get-kb-lookup` | `KBID` | List of all existing knowledge bases. |
| **Catalog Products** | `GET /api/v1/external/kb-catalog/get-product-lookup?AgentID={id}` | `ProductList` | Products associated with an agent's knowledge base. |
| **Catalog Services** | `GET /api/v1/external/kb-catalog/get-service-lookup?AgentID={id}` | `ServiceList` | Services associated with an agent's knowledge base. |

***

## 5. Campaign & Telephony Lookups

Use these lookups before scheduling outbound calling batches:

| Lookup Entity | Method & Endpoint | Used In | Description |
| - | - | - | - |
| **Outbound Campaigns** | `GET /api/v1/external/campaign/get-OutboundCampLookup` | `CampaignKeyID` | Active campaigns in the workspace. |
| **Virtual Numbers** | `GET /api/v1/external/campaign/get-CampaignPhoneNumbersLookup` | `PhoneNumberKeyID` | Virtual phone numbers available for caller ID outbound dialing. |
| **Stop Rules** | `GET /api/v1/external/stopRule/get-stopRuleLookup` | `StopRuleID` | Rules defining when dialing stops (e.g., after 3 failed attempts or upon lead qualification). |
| **Launch Settings** | `GET /api/v1/external/launchSetting/get-launchSettingLookup` | `LaunchSettingID` | Batch pacing and concurrency limits. |
| **Sales Team Reps** | `GET /api/v1/external/SalesUser/get-SalesUserLookup` | `SalesUserID` | Sales reps eligible for lead and call routing. |

***

## 6. Practical cURL Examples

```bash theme={null}
# Fetch available industries
curl -X GET "https://api.dashboard.valuez.ai/api/v1/external/industry/get-industryLookup" \
  -H "x-api-key: $VALUEZ_API_KEY"

# Fetch available phone numbers for outbound campaigns
curl -X GET "https://api.dashboard.valuez.ai/api/v1/external/campaign/get-CampaignPhoneNumbersLookup" \
  -H "x-api-key: $VALUEZ_API_KEY"

# Fetch products linked to Agent ID 17
curl -X GET "https://api.dashboard.valuez.ai/api/v1/external/kb-catalog/get-product-lookup?AgentID=17" \
  -H "x-api-key: $VALUEZ_API_KEY"
```

<CardGroup cols={2}>
  <Card title="Build Agents & Knowledge" icon="brain" href="/dev-agents-knowledge">
    Use these IDs to construct your AI agent and KB.
  </Card>

  <Card title="Launch Campaigns" icon="phone" href="/dev-campaigns">
    Use phone numbers and stop rules to schedule campaigns.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.