> ## Documentation Index
> Fetch the complete documentation index at: https://docs.socq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Link in Bio

> Get the bio, contact email, social profiles and every link on Linktree, Komi, lnk.bio and Link.me pages.

# Link in Bio

Send the link-in-bio URLs you find in creator profiles and get each page back as one record: display name, bio, avatar, the contact email when the creator lists one, links to their other social accounts, and every button on the page with its title and destination. Linktree, Komi, lnk.bio and Link.me pages can go in the same request, so a mixed list scraped from Instagram or TikTok bios needs no sorting first.

```json theme={"dark"}
{
  "urls": [
    "https://linktr.ee/miguelangeles",
    "https://kimkardashian.komi.io",
    "https://lnk.bio/msjennafischer",
    "https://link.me/danucd"
  ]
}
```

Provide up to 50 page URLs in urls: linktr.ee/name, name.komi.io, lnk.bio/name or link.me/name. Each page found returns one row and costs 0.5 credits. Pages that no longer exist are skipped; the task fails with a refund only when none of them can be read.

## Standard Result Fields

Task results use the stable SocQ fields below. Source-specific field names and formats are normalized without inferring or enriching values that the source did not provide. To request a smaller field set, use `fields` for MCP queries, `_result_fields` for typed tools, or `--result-fields` in the CLI. Declared fields remain present when their value is `null`.

| Field | Type | Nullable | Description |
| - | - | - | - |
| `id` | `string` | Yes | Service and page name, such as `linktree:miguelangeles`. |
| `platform` | `string` | No | Platform the result belongs to, such as `instagram` or `linkedin`. |
| `resource` | `string` | No | SocQ resource represented by the result, such as `videos` or `comments`. |
| `type` | `string` | No | Category of the result item, such as `video`, `post`, or `comment`. |
| `url` | `string` | Yes | URL of the link-in-bio page. |
| `published_at` | `string` | Yes | Time the source item was published, in ISO 8601 format when available. |
| `collected_at` | `string` | No | Time SocQ collected or processed this result, in ISO 8601 format. |
| `service` | `string` | Yes | Service hosting the page: `linktree`, `komi`, `lnk.bio`, `link.me` or `pillar`. |
| `username` | `string` | Yes | Page name on the service. |
| `name` | `string` | Yes | Display name of the creator, when the page shows one. |
| `text` | `string` | Yes | Bio shown on the page. |
| `avatar_url` | `string` | Yes | URL of the creator's profile photo. |
| `is_verified` | `boolean` | Yes | Whether the page carries the service's verified badge. |
| `email` | `string` | Yes | Contact email listed on the page, when any. |
| `social_urls` | `array<string>` | Yes | Social profiles and websites linked from the page's icons. |
| `links` | `array<object>` | Yes | Links on the page, in the order shown. |
| `links.title` | `string` | Yes | Label of the link. |
| `links.url` | `string` | Yes | Address the link opens. |
| `links.type` | `string` | Yes | Kind of link reported by the service, such as `link` or `spotify_album`. |
| `links.thumbnail_url` | `string` | Yes | URL of the link's thumbnail image, when any. |
| `links_count` | `integer` | Yes | Number of links on the page. |

The following example shows the response format for a completed task. Actual data depends on your query.

## Completed Task Response

```json theme={"dark"}
{
  "code": 200,
  "data": {
    "task_id": "example-link-in-bio-profile",
    "status": "succeeded",
    "public_id": "link-in-bio/profile",
    "result_count": 1,
    "credits_amount": 0.5,
    "results": {
      "limit": 50,
      "next_cursor": null,
      "has_more": false,
      "schema_id": "link-page",
      "schema_version": "1.0",
      "items": [
        {
          "id": "komi:kimkardashian",
          "platform": "link-in-bio",
          "resource": "profile",
          "type": "page",
          "url": "https://kimkardashian.komi.io",
          "published_at": null,
          "collected_at": "2026-11-17T23:54:13.933684Z",
          "service": "komi",
          "username": "kimkardashian",
          "name": "Kim Kardashian",
          "text": null,
          "avatar_url": "https://komi-production-assets.s3.amazonaws.com/photos/4Nd69ODJHs61_iNYPlqos.jpg",
          "is_verified": null,
          "email": null,
          "social_urls": [
            "https://www.instagram.com/kimkardashian/",
            "https://www.tiktok.com/@kimkardashian",
            "https://www.youtube.com/@KUWTK"
          ],
          "links": [
            {
              "title": "Visit SKIMS",
              "url": "https://skims.social/shop-skims",
              "type": "link",
              "thumbnail_url": "https://komi-production-assets.s3-accelerate.amazonaws.com/photos/x_LQCBYzoWiel0-yrAnrF.jpg"
            },
            {
              "title": "UPDATE ENERGY DRINK",
              "url": "https://drinkupdate.com/?srsltid=AfmBOooIad8vPZueD_CvcKcyVCG1KbYiz1fU-or88He0HmecDhK35kKL",
              "type": "link",
              "thumbnail_url": "https://komi-production-assets.s3-accelerate.amazonaws.com/photos/P9U67dVgGygBfMw6UyphZ.jpeg"
            },
            {
              "title": "The Kardashians | Season 7 | Official Trailer | Hulu",
              "url": "https://www.youtube.com/watch?v=W8dNXLBd1RM",
              "type": "youtube_video",
              "thumbnail_url": null
            }
          ],
          "links_count": 21
        }
      ]
    }
  }
}
```


## OpenAPI

````yaml api-manual/agent-api/agent-api.json POST /v1/link-in-bio/profile
openapi: 3.1.0
info:
  title: SocQ Agent API
  version: v1-87892a6484c2
  description: Asynchronous social data API generated from the SocQ Capability Registry.
servers:
  - url: https://api.socq.ai
security: []
paths:
  /v1/link-in-bio/profile:
    post:
      tags:
        - link-in-bio
      summary: Link in Bio API
      description: >-
        Collect the bio, contact email, social profiles and links of Linktree,
        Komi, lnk.bio and Link.me pages.
      operationId: socq_link_in_bio_profile
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              additionalProperties: false
              properties:
                callback_url:
                  type: string
                  format: uri
                urls:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  minItems: 1
                  description: >-
                    Link-in-bio page URLs, up to 50, such as
                    https://linktr.ee/<name>, https://<name>.komi.io,
                    https://lnk.bio/<name> or https://link.me/<name>.
                  maxItems: 50
              required:
                - urls
              description: >-
                Provide up to 50 link-in-bio page URLs in urls; Linktree, Komi,
                lnk.bio and Link.me pages can be mixed in one request. Each page
                returns one row with the creator's name, bio, avatar, social
                profiles, contact email when listed, and every link on the page.
      responses:
        '200':
          description: Task accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentSubmitResponse'
        '422':
          description: Input validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentValidationErrorResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    AgentSubmitResponse:
      type: object
      properties:
        code:
          type: integer
          const: 200
        data:
          type: object
          properties:
            task_id:
              type: string
            status:
              type: string
            created_time:
              type:
                - string
                - 'null'
          required:
            - task_id
            - status
    AgentValidationErrorResponse:
      type: object
      properties:
        code:
          type: integer
          const: 422
        error:
          type: object
          properties:
            message:
              type: string
            type:
              type: string
            details:
              type: object
          required:
            - message
            - type
      required:
        - code
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.