API reference

Sharing API

Publish a section or a whole project at a stable public link, read its sharing state, or revoke the link.

BetaUpdated September 30, 2026

Markdown Ask ChatGPT Ask Claude

Base URL: https://lyricwinter.com/api/v1
Authentication: Authorization: Bearer lw_…
Contract: openapi.json

GET/studio/sections/{sectionId}/share

Scope studio:read

Returns whether the section is public and its active public link, if any.

Path parameters

sectionIdstringrequireduuid

Response 200

Current section sharing state. Fields below are inside data.

schema_version1required
section_idstringrequireduuid
is_publicbooleanrequired
shareobject | nullrequired
Active link; non-null exactly when is_public is true.
3 child attributes
- idstringrequireduuid
- urlstringrequireduri
  Public section page URL of the form <origin>/s/<token>.
- created_atstringrequireddate-time

Errors 400, 401, 403, 404, 500, 503 use the standard error envelope.

curl "https://lyricwinter.com/api/v1/studio/sections/$SECTION_ID/share" \
  -H "Authorization: Bearer $LYRICWINTER_API_KEY"

const sectionId = "<sectionId>";
const response = await fetch(`https://lyricwinter.com/api/v1/studio/sections/${sectionId}/share`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.LYRICWINTER_API_KEY}`,
  },
});
const { data, error, request_id } = await response.json();

import os
import requests

section_id = "<sectionId>"
response = requests.request(
    "GET",
    f"https://lyricwinter.com/api/v1/studio/sections/{section_id}/share",
    headers={
        "Authorization": f"Bearer {os.environ['LYRICWINTER_API_KEY']}",
    },
)
payload = response.json()

Response 200 (example)

{
  "data": {
    "schema_version": 1,
    "section_id": "8f14e45f-ceea-4e7a-9c2d-3b1a5f2e7c10",
    "is_public": true,
    "share": {
      "id": "c9f0f895-fb98-4b91-9e3f-1d2a6b7c8d20",
      "url": "https://lyricwinter.com/…",
      "created_at": "2026-09-30T17:00:00.000Z"
    }
  },
  "request_id": "req_01J9Z3K8QF4"
}

POST/studio/sections/{sectionId}/share

Scope studio:write

Creates a stable public link for the section, or returns the existing one. The public page always plays the latest saved version. Send an empty JSON object as the body.

Path parameters

sectionIdstringrequireduuid

Request body application/json

object

Must be an empty JSON object.

Response 201

Section published with its active link (also returned when already public). Fields below are inside data.

schema_version1required
section_idstringrequireduuid
is_publicbooleanrequired
shareobject | nullrequired
Active link; non-null exactly when is_public is true.
3 child attributes
- idstringrequireduuid
- urlstringrequireduri
  Public section page URL of the form <origin>/s/<token>.
- created_atstringrequireddate-time

Errors 400, 401, 403, 404, 409, 500, 503 use the standard error envelope.

curl -X POST "https://lyricwinter.com/api/v1/studio/sections/$SECTION_ID/share" \
  -H "Authorization: Bearer $LYRICWINTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

const sectionId = "<sectionId>";
const response = await fetch(`https://lyricwinter.com/api/v1/studio/sections/${sectionId}/share`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LYRICWINTER_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { data, error, request_id } = await response.json();

import os
import requests

section_id = "<sectionId>"
response = requests.request(
    "POST",
    f"https://lyricwinter.com/api/v1/studio/sections/{section_id}/share",
    headers={
        "Authorization": f"Bearer {os.environ['LYRICWINTER_API_KEY']}",
    },
    json={},
)
payload = response.json()

Response 201 (example)

{
  "data": {
    "schema_version": 1,
    "section_id": "8f14e45f-ceea-4e7a-9c2d-3b1a5f2e7c10",
    "is_public": true,
    "share": {
      "id": "c9f0f895-fb98-4b91-9e3f-1d2a6b7c8d20",
      "url": "https://lyricwinter.com/…",
      "created_at": "2026-09-30T17:00:00.000Z"
    }
  },
  "request_id": "req_01J9Z3K8QF4"
}

DELETE/studio/sections/{sectionId}/share

Scope studio:write

Revokes the section's public link and makes the section private.

Path parameters

sectionIdstringrequireduuid

Response 200

Section is private and the prior link is revoked. Fields below are inside data.

schema_version1required
section_idstringrequireduuid
is_publicbooleanrequired
shareobject | nullrequired
Active link; non-null exactly when is_public is true.
3 child attributes
- idstringrequireduuid
- urlstringrequireduri
  Public section page URL of the form <origin>/s/<token>.
- created_atstringrequireddate-time

Errors 400, 401, 403, 404, 500, 503 use the standard error envelope.

curl -X DELETE "https://lyricwinter.com/api/v1/studio/sections/$SECTION_ID/share" \
  -H "Authorization: Bearer $LYRICWINTER_API_KEY"

const sectionId = "<sectionId>";
const response = await fetch(`https://lyricwinter.com/api/v1/studio/sections/${sectionId}/share`, {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.LYRICWINTER_API_KEY}`,
  },
});
const { data, error, request_id } = await response.json();

import os
import requests

section_id = "<sectionId>"
response = requests.request(
    "DELETE",
    f"https://lyricwinter.com/api/v1/studio/sections/{section_id}/share",
    headers={
        "Authorization": f"Bearer {os.environ['LYRICWINTER_API_KEY']}",
    },
)
payload = response.json()

Response 200 (example)

{
  "data": {
    "schema_version": 1,
    "section_id": "8f14e45f-ceea-4e7a-9c2d-3b1a5f2e7c10",
    "is_public": true,
    "share": {
      "id": "c9f0f895-fb98-4b91-9e3f-1d2a6b7c8d20",
      "url": "https://lyricwinter.com/…",
      "created_at": "2026-09-30T17:00:00.000Z"
    }
  },
  "request_id": "req_01J9Z3K8QF4"
}

GET/studio/projects/{projectId}/share

Scope studio:read

Returns whether the project has a public link and the active link, if any.

Path parameters

projectIdstringrequireduuid

Response 200

Current project public-link state. Fields below are inside data.

schema_version1required
project_idstringrequireduuid
is_publicbooleanrequired
shareobject | nullrequired
Active link; non-null exactly when is_public is true.
3 child attributes
- idstringrequireduuid
- urlstringrequireduri
  Public project page URL of the form <origin>/p/<token>.
- created_atstringrequireddate-time

Errors 400, 401, 403, 404, 500, 503 use the standard error envelope.

curl "https://lyricwinter.com/api/v1/studio/projects/$PROJECT_ID/share" \
  -H "Authorization: Bearer $LYRICWINTER_API_KEY"

const projectId = "<projectId>";
const response = await fetch(`https://lyricwinter.com/api/v1/studio/projects/${projectId}/share`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.LYRICWINTER_API_KEY}`,
  },
});
const { data, error, request_id } = await response.json();

import os
import requests

project_id = "<projectId>"
response = requests.request(
    "GET",
    f"https://lyricwinter.com/api/v1/studio/projects/{project_id}/share",
    headers={
        "Authorization": f"Bearer {os.environ['LYRICWINTER_API_KEY']}",
    },
)
payload = response.json()

Response 200 (example)

{
  "data": {
    "schema_version": 1,
    "project_id": "8f14e45f-ceea-4e7a-9c2d-3b1a5f2e7c10",
    "is_public": true,
    "share": {
      "id": "c9f0f895-fb98-4b91-9e3f-1d2a6b7c8d20",
      "url": "https://lyricwinter.com/…",
      "created_at": "2026-09-30T17:00:00.000Z"
    }
  },
  "request_id": "req_01J9Z3K8QF4"
}

Share a project

POST/studio/projects/{projectId}/share

Scope studio:write

Creates a stable public link for the whole project, or returns the existing one. Send an empty JSON object as the body.

Path parameters

projectIdstringrequireduuid

Request body application/json

object

Must be an empty JSON object.

Response 201

Stable project public link. Fields below are inside data.

schema_version1required
project_idstringrequireduuid
is_publicbooleanrequired
shareobject | nullrequired
Active link; non-null exactly when is_public is true.
3 child attributes
- idstringrequireduuid
- urlstringrequireduri
  Public project page URL of the form <origin>/p/<token>.
- created_atstringrequireddate-time

Errors 400, 401, 403, 404, 409, 500, 503 use the standard error envelope.

curl -X POST "https://lyricwinter.com/api/v1/studio/projects/$PROJECT_ID/share" \
  -H "Authorization: Bearer $LYRICWINTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

const projectId = "<projectId>";
const response = await fetch(`https://lyricwinter.com/api/v1/studio/projects/${projectId}/share`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LYRICWINTER_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { data, error, request_id } = await response.json();

import os
import requests

project_id = "<projectId>"
response = requests.request(
    "POST",
    f"https://lyricwinter.com/api/v1/studio/projects/{project_id}/share",
    headers={
        "Authorization": f"Bearer {os.environ['LYRICWINTER_API_KEY']}",
    },
    json={},
)
payload = response.json()

Response 201 (example)

{
  "data": {
    "schema_version": 1,
    "project_id": "8f14e45f-ceea-4e7a-9c2d-3b1a5f2e7c10",
    "is_public": true,
    "share": {
      "id": "c9f0f895-fb98-4b91-9e3f-1d2a6b7c8d20",
      "url": "https://lyricwinter.com/…",
      "created_at": "2026-09-30T17:00:00.000Z"
    }
  },
  "request_id": "req_01J9Z3K8QF4"
}

DELETE/studio/projects/{projectId}/share

Scope studio:write

Revokes the project's public link. Send no request body.

Path parameters

projectIdstringrequireduuid

Response 200

Project sharing is revoked. Fields below are inside data.

schema_version1required
project_idstringrequireduuid
is_publicbooleanrequired
shareobject | nullrequired
Active link; non-null exactly when is_public is true.
3 child attributes
- idstringrequireduuid
- urlstringrequireduri
  Public project page URL of the form <origin>/p/<token>.
- created_atstringrequireddate-time

Errors 400, 401, 403, 404, 500, 503 use the standard error envelope.

curl -X DELETE "https://lyricwinter.com/api/v1/studio/projects/$PROJECT_ID/share" \
  -H "Authorization: Bearer $LYRICWINTER_API_KEY"

const projectId = "<projectId>";
const response = await fetch(`https://lyricwinter.com/api/v1/studio/projects/${projectId}/share`, {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.LYRICWINTER_API_KEY}`,
  },
});
const { data, error, request_id } = await response.json();

import os
import requests

project_id = "<projectId>"
response = requests.request(
    "DELETE",
    f"https://lyricwinter.com/api/v1/studio/projects/{project_id}/share",
    headers={
        "Authorization": f"Bearer {os.environ['LYRICWINTER_API_KEY']}",
    },
)
payload = response.json()

Response 200 (example)

{
  "data": {
    "schema_version": 1,
    "project_id": "8f14e45f-ceea-4e7a-9c2d-3b1a5f2e7c10",
    "is_public": true,
    "share": {
      "id": "c9f0f895-fb98-4b91-9e3f-1d2a6b7c8d20",
      "url": "https://lyricwinter.com/…",
      "created_at": "2026-09-30T17:00:00.000Z"
    }
  },
  "request_id": "req_01J9Z3K8QF4"
}

Get section sharing

Path parameters

Response 200

Share a section

Path parameters

Request body application/json

Response 201

Stop sharing a section

Path parameters

Response 200

Get project sharing

Path parameters

Response 200

Share a project

Path parameters

Request body application/json

Response 201

Stop sharing a project

Path parameters

Response 200