Skip to main content
Documentation

Getting Started

Go from zero to your first Pro Clubs player card image in under 3 minutes. This guide walks you through obtaining an API key, making your first request, and retrieving the result.

Prerequisites

  • A Pro Clubs Studio partner account with an API key. See the Authentication guide for details.
  • A tool for making HTTP requests — curl, your favourite HTTP client, or any programming language.

Environments

Pro Clubs Studio provides two environments for development and production use:

Live

Keys prefixed with sk_live_. Deducts real credits, produces production-quality images.

Test

Keys prefixed with sk_test_. No credit deduction, watermarked output. Ideal for development.

1

Get your API key

Log in to the Partner Console and generate an API key. Your key will be shown only once — store it securely. For testing, use a sk_test_ key to avoid consuming credits.

Security note: Never expose your API key in client-side code. Always make API calls from your server.

2

Create your first image

Submit a POST request to the images endpoint. The API returns immediately with an image_id while processing happens asynchronously.

curl -X POST "https://api.proclubsstudio.com/v1/images" \
  -H "X-API-Key: sk_live_your_key_here" \
  -H "Idempotency-Key: my-first-image-001" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "player_card",
    "player": {
      "external_id": "player_001",
      "name": "Zethxr",
      "position": "ST",
      "number": 18,
      "skill_level": 88,
      "source_image_url": "https://your-app.com/uploads/player.png"
    },
    "style": {
      "preset": "pro_clubs_card",
      "width": 1024,
      "height": 1280
    }
  }'

You'll receive a 202 Accepted response:

{
  "success": true,
  "data": {
    "image_id": "img_01HSXYZ9Y5T8S5H0R9F3A2M7Q1",
    "status": "processing",
    "poll_url": "/v1/images/img_01HSXYZ9Y5T8S5H0R9F3A2M7Q1",
    "eta_seconds": 15,
    "created_at": "2026-02-19T11:30:00Z"
  },
  "error": null
}
3

Check the result

Poll the image status using the image_id from the previous response. Images typically complete within 10–20 seconds.

curl "https://api.proclubsstudio.com/v1/images/img_01HSXYZ9Y5T8S5H0R9F3A2M7Q1" \
  -H "X-API-Key: sk_live_your_key_here"

Once processing completes, the response includes the image URL:

{
  "success": true,
  "data": {
    "image_id": "img_01HSXYZ9Y5T8S5H0R9F3A2M7Q1",
    "status": "completed",
    "result": {
      "image_url": "https://cdn.proclubsstudio.com/partner/img_01HSXYZ9Y5T8S5H0R9F3A2M7Q1.png",
      "width": 1024,
      "height": 1280,
      "content_type": "image/png",
      "expires_at": "2026-05-21T11:30:12Z"
    },
    "usage": { "credits_used": 1 },
    "created_at": "2026-02-19T11:30:00Z",
    "completed_at": "2026-02-19T11:30:12Z"
  },
  "error": null
}

Next steps