| description | Welcome to your team’s developer platform | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| icon | house | ||||||||||||||||||||||||||||||
| layout |
|
Ask a question...
Get startedAuthenticateIntegrateContribute
| No code | Get started with the developer platform in 5 minutes. | Documentation | no-code.jpg | |
| Hosted | Learn more about hosting the developer platform. | Documentation | hosted.jpg | |
| API reference | Browse, test, and implement APIs. | API Reference | api-reference.jpg |
{% columns %} {% column width="50%" %}
Make your first API call in under 5 minutes.
This quickstart walks through the basic setup: create an account, generate an API key, and send a test request. The examples use the same request in several languages, so you can start with the one that matches your stack.
{% hint style="info" icon="sparkle" %} Customize your first request
Explain what you're building and let AI tweak your quickstart.
What are you building? {% endhint %}
{% hint style="warning" icon="life-ring" %} Need some help?
Troubleshoot common issues or ask for help.
I get a 401 Unauthorized error
Check that your API key is present and valid.
Make sure you replaced YOUR_API_KEY in the example.
Confirm the Authorization header uses Bearer YOUR_API_KEY.
I get a 400 Bad Request error
Check your request body first.
Make sure the JSON is valid and the message field is included.
Also confirm you send Content-Type: application/json.
The request succeeds, but the result is not what I expect
Start with the sample payload before testing custom input.
Check the response status field to confirm whether the request was only queued.
If you change the payload shape, verify the endpoint accepts those fields.
My local example does not run
Check that your runtime and dependencies are installed.
For JavaScript, install the SDK before running the example.
For Python, make sure requests is available in your environment.
Explain what's happening... {% endhint %}
With your first request done, use the guides for deeper setup and the API reference for endpoints and parameters.
{% endcolumn %}
{% column width="50%" %} {% stepper %} {% step %}
Set up your account, then generate an API key for local testing and your first integration.
{% step %}
Pick a language below, replace YOUR_API_KEY, and run.
{% tabs %} {% tab title="JavaScript" %} {% code overflow="wrap" %}
// Import the SDK
import ExampleAPI from "example-api";
// Initialize the client
const client = new ExampleAPI({ apiKey: "YOUR_API_KEY" });
// Send your first message
const response = await client.messages.send({
message: "Hello, world!"
});{% endcode %} {% endtab %}
{% tab title="Python" %} {% code overflow="wrap" %}
import requests
response = requests.post(
"https://api.example.com/messages",
headers={
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json",
},
json={
"message": "Hello, world!"
},
)
print(response.json()){% endcode %} {% endtab %}
{% tab title="cURL" %} {% code overflow="wrap" %}
curl -X POST https://api.example.com/messages \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"message": "Hello, world!"
}'{% endcode %} {% endtab %}
{% tab title="Go" %} {% code overflow="wrap" expandable="true" %}
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
body := []byte(`{"message":"Hello, world!"}`)
req, err := http.NewRequest("POST", "https://api.example.com/messages", bytes.NewBuffer(body))
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
responseBody, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(responseBody))
}{% endcode %} {% endtab %} {% endtabs %} {% endstep %}
{% step %}
If the request succeeds, you should get a response like this:
{% code title="response.json" overflow="wrap" %}
{
"id": "msg_1234567890",
"message": "Hello, world!",
"status": "queued",
"createdAt": "2026-01-01T12:00:00Z"
}{% endcode %} {% endstep %} {% endstepper %} {% endcolumn %} {% endcolumns %}
{% columns %} {% column width="50%" %}
{% endcolumn %}{% column width="50%" valign="middle" %}
Read guides, watch tutorials, and learn more about working with the developer platform and integrating it with your own stack.
Guides Documentation {% endcolumn %} {% endcolumns %}
Join our Discord community or create your first PR in just a few steps.
| Discord community | Join our Discord community to post questions, get help, and share resources with over 3,000 like-minded developers. | Join Discord | https://www.gitbook.com/ | ||
| GitHub | Our product is 100% open source and built by developers just like you. Head to our GitHub repository to learn how to submit your first PR. | Submit a PR | https://www.gitbook.com/ |
