CastStock

API Access

Access CastStock programmatically to search models, retrieve profile data, fetch images, and generate persona replies for your workflows.

Availability

Medium plan and above

Base URL

https://caststock.com/api/v1

Authentication

x-api-key

API Key

Available in your profile dashboard

How access works

API access is available on Medium and higher subscription plans.

Send your API key in the x-api-key header with each request.

The API mirrors the data available in the CastStock interface for your plan.

GET/search

Search available models by keyword or tag.

Query parameters

  • q — optional search term
  • tag — optional tag filter
  • limit — optional result limit

Example request

GET https://caststock.com/api/v1/search?q=nurse&limit=10

Example response

{
  "items": [
    {
      "slug": "jasmine-tan",
      "fullName": "Jasmine Tan",
      "imageUrl": "https://caststock.com/models/jasmine-tan.webp",
      "mbtiType": "ISFJ",
      "tags": ["nursing", "patient-care", "mid-career"],
      "isExclusive": false
    }
  ]
}
GET/get-profile

Retrieve structured profile data for a specific model.

Query parameters

  • slug — required model identifier

Example request

GET https://caststock.com/api/v1/get-profile?slug=jasmine-tan

Important

The amount of data returned depends on your subscription plan.

If a field is not visible on the model page for your plan, it will not be included in the API response.

The API mirrors the data available in the CastStock interface for your plan.

Example response

{
  "slug": "jasmine-tan",
  "fullName": "Jasmine Tan",
  "tagline": "It’s amazing how well a well-placed fastener can manage unexpected variables.",
  "mbtiType": "ISTJ",
  "tags": ["nursing", "patient-care", "mid-career"],
  "traits": ["practical", "empathetic", "structured"],
  "values": ["stability", "care", "consistency"],
  "fears": ["losing control", "unexpected chaos"]
}
GET/get-image

Retrieve a model image for licensed use.

Query parameters

  • slug — required model identifier
  • image — required image identifier or filename
  • mode — optional image mode

Example request

GET https://caststock.com/api/v1/get-image?slug=jasmine-tan&image=shot01.webp&mode=full

Example response

{
  "slug": "jasmine-tan",
  "image": "shot01.webp",
  "mode": "full",
  "url": "https://caststock.com/api/v1/get-image?slug=jasmine-tan&image=shot01.webp&mode=full"
}
POST/reply

Ask a persona to reply to a forum-style post, customer message, or any text input.

Request body

  • slug — required model identifier
  • text — required input text
  • context — optional extra context

Example request

POST https://caststock.com/api/v1/reply
x-api-key: YOUR_API_KEY
content-type: application/json

{
  "slug": "jasmine-tan",
  "text": "I'm not sure whether I should leave my stable job for a startup.",
  "context": "User is worried about risk and long-term stability."
}

Important

Reply generation availability and quality depend on your subscription plan.

Higher plans can include more context, richer profile data, and conversation memory features.

Example response

{
  "slug": "jasmine-tan",
  "fullName": "Jasmine Tan",
  "reply": "If stability matters a lot to you, I’d probably slow the decision down and look at the downside in practical terms first. A startup can be exciting, but it helps to know exactly what risk you’re taking before you jump.",
  "meta": {
    "usedProductKnowledge": false,
    "usedConversationMemory": false
  }
}

Need API access?

API access is included with the Medium plan and above. If you need a custom setup or have questions about integration, contact us.

View pricingContact us