# Getting started

### Step 0: Head to [platform.flock.io ](https://platform.flock.io/)and sign up

<figure><img src="https://742781353-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1RpcbvTSHzzPwOSUvgKU%2Fuploads%2Fn0cnvIt6HYPgpxZV0PMt%2FScreenshot%202026-02-28%20at%2018.39.38.png?alt=media&#x26;token=d8253109-2b13-4bda-8875-2e7c6cfafbee" alt=""><figcaption></figcaption></figure>

### Step 1: Create an Team

Create a team to manage your organization’s API usage, billing, and access control in one place.\
All API keys, credits, logs, and members will belong to this team.

<figure><img src="https://742781353-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1RpcbvTSHzzPwOSUvgKU%2Fuploads%2F94WrTfzv7WFiTDxRJdqj%2FScreenshot%202026-02-28%20at%2018.40.36.png?alt=media&#x26;token=9ad7cb48-9631-4479-bedc-2926911c25a1" alt=""><figcaption></figcaption></figure>

### Step 2: Create an API key

To start using the API, you will be prompted to create the API key first

<figure><img src="https://742781353-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1RpcbvTSHzzPwOSUvgKU%2Fuploads%2FnRsLmPm32Ha8cToNep7o%2FScreenshot%202026-02-28%20at%2018.41.08.png?alt=media&#x26;token=10f07674-14db-45d0-8940-82380c526e93" alt=""><figcaption></figcaption></figure>

Please keep your API key safe as you won't be able to see it again. If you lose it, please create a new key.

### Step 3: Use the API

Use your API key to authenticate requests from your application.

You can integrate the API using:

* REST endpoints
* Official SDKs (if available)
* Command-line tools
* Server-side applications

Please refer the section [API Endpoints](https://docs.flock.io/flock-products/api-platform/api-endpoint) for request formats, endpoints, and example code.

### Step 4: Buy credits

Before making requests, ensure your account has sufficient credits.

Navigate to **Settings → Billing** to purchase credits.

<div><figure><img src="https://742781353-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1RpcbvTSHzzPwOSUvgKU%2Fuploads%2FJIuaRRURCKbtLnxHmub0%2FScreenshot%202026-02-28%20at%2018.45.38.png?alt=media&#x26;token=17a1e321-1665-4842-90d6-a6cdf1464ae2" alt=""><figcaption></figcaption></figure> <figure><img src="https://742781353-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1RpcbvTSHzzPwOSUvgKU%2Fuploads%2FMC70a84GwqDCXuJxqqD6%2FScreenshot%202026-02-28%20at%2018.45.53.png?alt=media&#x26;token=96f645ba-1af0-4185-ab1f-721f52acfc34" alt=""><figcaption></figcaption></figure></div>

We support payments using Stripe, Base Pay, and Coinbase.

Credits are deducted automatically based on your API usage.

### Step 5: Track Usage

Monitor activity and costs in real time:

* **Logs tab** — View detailed request logs for selected time ranges, including status, latency, and errors

<figure><img src="https://742781353-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1RpcbvTSHzzPwOSUvgKU%2Fuploads%2Fuhlg9NN87YCEExtV0CvX%2FScreenshot%202026-02-28%20at%2018.46.24.png?alt=media&#x26;token=36434b4b-fbba-4d54-ad61-c93564fc0185" alt=""><figcaption></figcaption></figure>

* **Usage tab** — Track total requests, token consumption, and average cost per request

<figure><img src="https://742781353-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1RpcbvTSHzzPwOSUvgKU%2Fuploads%2FIm1zdkuZ1uacr2bQsx9v%2FScreenshot%202026-02-28%20at%2018.46.17.png?alt=media&#x26;token=64dc1159-d274-4744-88db-2df6a1dc7628" alt=""><figcaption></figcaption></figure>

This helps you debug issues, optimize usage, and manage spending.

### Step 6: Adding members to your organisation

Invite teammates to collaborate on the platform.

Go to **Teams → Members** to:

* Add new users
* Assign roles and permissions
* Manage access to API keys, billing, and logs

All members will operate under the same team workspace.

<figure><img src="https://742781353-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1RpcbvTSHzzPwOSUvgKU%2Fuploads%2F7Kdk0zVpPnvG5ZAY264F%2FScreenshot%202026-02-28%20at%2018.46.49.png?alt=media&#x26;token=59f1039a-b943-411b-90ee-2d1cc8ff7513" alt=""><figcaption></figcaption></figure>

### Step 7: API Playground

Experiment with the API directly in your browser.

The Playground allows you to:

* Test different models
* Try prompts and parameters
* View responses instantly
* Generate sample code for integration

It’s the fastest way to explore capabilities before building your application.

<figure><img src="https://742781353-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1RpcbvTSHzzPwOSUvgKU%2Fuploads%2Fq2VnW7cTGJrHb65qnshA%2FScreenshot%202026-02-28%20at%2018.47.10.png?alt=media&#x26;token=fcb97ffc-9763-4121-890f-e36aa2c9b5d9" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.flock.io/flock-products/api-platform/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.