Quickstart

Connect a profile, create a key, send a test post and drop the SDK into your app — in 30 seconds.

Before you begin

You need a Nylon account with at least one connected social profile.

Open Connections and connect a profile.
Open API keys.
Select Create key, give the key a recognizable name, and copy it.

Nylon only displays a newly created API key once. Store it in your secret manager and never commit it to source control.

Use the SDK, or raw HTTP

Every step below is shown in curl, Node and Python so you can follow it in any stack. If you are on TypeScript or JavaScript, the official SDK does the same thing with retries that cannot double-post, typed errors and webhook verification already handled:

npm install @nylon-dev/sdk

import { Nylon } from '@nylon-dev/sdk'

const nylon = new Nylon({ apiKey: process.env.NYLON_API_KEY })

const { data: profiles } = await nylon.profiles.list()
const post = await nylon.posts.create({
  profile_ids: profiles.map(profile => profile.id),
  text: 'Shipping today.',
})

TypeScript SDK

Installation, resources, error handling and configuration.

1. List your profiles

A post is addressed to profile ids, so this is where every integration starts.

curl "https://api.nylon.dev/v1/profiles" \
  -H "Authorization: Bearer nylon_live_YOUR_API_KEY"

const response = await fetch('https://api.nylon.dev/v1/profiles', {
  headers: { Authorization: 'Bearer nylon_live_YOUR_API_KEY' },
})

if (!response.ok) {
  const { error } = await response.json()
  throw new Error(`${error.code}: ${error.message}`)
}

const { data } = await response.json()
console.log(data)

import requests

response = requests.get(
    'https://api.nylon.dev/v1/profiles',
    headers={'Authorization': 'Bearer nylon_live_YOUR_API_KEY'},
)
response.raise_for_status()

print(response.json()['data'])

Response

{
  "data": [
    {
      "id": "cly7p2q4k0001x8b3f2n9d0aa",
      "network": "instagram",
      "external_id": "17841400000000000",
      "name": "Nylon Studio",
      "handle": "nylonstudio",
      "avatar_url": "https://cdn.example.com/avatar.jpg",
      "profile_url": "https://www.instagram.com/nylonstudio",
      "status": "active",
      "suspended": false,
      "connected_at": "2026-05-14T10:20:00.000Z"
    }
  ],
  "meta": {
    "pagination": { "limit": 25, "offset": 0, "total": 1, "has_more": false }
  }
}

2. Check the post before you send it

POST /v1/validate takes the same body as a publish and tells you what every addressed network thinks of it — including how a long caption will be split into a thread. Nothing is published.

cURL

curl "https://api.nylon.dev/v1/validate" \
  -H "Authorization: Bearer nylon_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "profile_ids": ["cly7p2q4k0001x8b3f2n9d0aa"],
    "text": "Shipping day. The new editor is live for everyone.",
    "media": ["https://cdn.example.com/launch.jpg"]
  }'

3. Publish

Same body, real endpoint.

curl "https://api.nylon.dev/v1/posts" \
  -H "Authorization: Bearer nylon_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "profile_ids": ["cly7p2q4k0001x8b3f2n9d0aa"],
    "text": "Shipping day. The new editor is live for everyone.",
    "media": ["https://cdn.example.com/launch.jpg"],
    "idempotency_key": "launch-2026-09-10"
  }'

const response = await fetch('https://api.nylon.dev/v1/posts', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer nylon_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    profile_ids: ['cly7p2q4k0001x8b3f2n9d0aa'],
    text: 'Shipping day. The new editor is live for everyone.',
    media: ['https://cdn.example.com/launch.jpg'],
    idempotency_key: 'launch-2026-09-10',
  }),
})

const { data, error } = await response.json()
if (error) throw new Error(`${error.code}: ${error.message}`)

for (const target of data.targets) {
  console.log(target.network, target.status, target.url)
}

import requests

response = requests.post(
    'https://api.nylon.dev/v1/posts',
    headers={'Authorization': 'Bearer nylon_live_YOUR_API_KEY'},
    json={
        'profile_ids': ['cly7p2q4k0001x8b3f2n9d0aa'],
        'text': 'Shipping day. The new editor is live for everyone.',
        'media': ['https://cdn.example.com/launch.jpg'],
        'idempotency_key': 'launch-2026-09-10',
    },
)

body = response.json()
for target in body['data']['targets']:
    print(target['network'], target['status'], target['url'])

Publishing is synchronous. The request returns once every target has been attempted, so a carousel or a video can take a while — allow a generous client timeout. What you get back is the outcome, not a job id to poll.

Response

{
  "data": {
    "id": "cly7q9v2m0001x8b3a1c4d0dd",
    "status": "published",
    "text": "Shipping day. The new editor is live for everyone.",
    "published_at": "2026-09-10T11:04:12.881Z",
    "targets": [
      {
        "id": "cly7q9v2m0002x8b3b5e6f0ee",
        "profile_id": "cly7p2q4k0001x8b3f2n9d0aa",
        "network": "instagram",
        "profile_name": "Nylon Studio",
        "status": "published",
        "post_ids": ["17924418112233445"],
        "url": "https://www.instagram.com/p/C8xYzAbCdEf/",
        "attempts": 1,
        "published_at": "2026-09-10T11:04:09.418Z",
        "error": null
      }
    ]
  }
}

To schedule instead, send scheduled_at with an ISO 8601 time in the future. The response is the same shape with status: "scheduled" and targets still pending.

4. Handle a partial failure

A post can succeed on one network and fail on another. That is not an error response — the post exists, and status is partially_published. Read the reason off each target and retry only what failed:

cURL

curl -X POST "https://api.nylon.dev/v1/posts/cly7q9v2m0001x8b3a1c4d0dd/retry" \
  -H "Authorization: Bearer nylon_live_YOUR_API_KEY"

Targets that already published are never re-sent, whatever you ask for.

Next steps

Network capabilities

Character limits, media specs and per-network options, as data you can check against.

Publishing

The model: accounts not networks, one payload many targets.

Errors

The taxonomy, per-network failure details and rate limits.

API reference

Every endpoint, with a playground.

Get started

Capabilities

Guides

Before you begin

Use the SDK, or raw HTTP

TypeScript SDK

1. List your profiles

2. Check the post before you send it

3. Publish

4. Handle a partial failure

Next steps

Network capabilities

Publishing

Errors

API reference

​Before you begin

​Use the SDK, or raw HTTP

TypeScript SDK

​1. List your profiles

​2. Check the post before you send it

​3. Publish

​4. Handle a partial failure

​Next steps

Network capabilities

Publishing

Errors

API reference

Before you begin

Use the SDK, or raw HTTP

1. List your profiles

2. Check the post before you send it

3. Publish

4. Handle a partial failure

Next steps