> ## 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.

# Pinterest Search

> Search public Pinterest Pins.

# Pinterest Search

```json theme={"system"}
{
  "query": "home office ideas",
  "results_limit": 100
}
```

## Use with MCP

| Interface      | Value                                              |
| -------------- | -------------------------------------------------- |
| REST           | `POST /v1/pinterest/search`                        |
| Compact MCP    | `socq_execute` with `endpoint: "pinterest/search"` |
| Typed MCP      | `socq_pinterest_search`                            |
| Exact-tool URL | `https://api.socq.ai/mcp?tools=pinterest_search`   |
| CLI            | `socq pinterest search`                            |

Use the JSON request body above as the nested `input` object for `socq_execute`, or pass the same fields directly to the typed tool. Typed tools also accept `_wait_seconds`, `_result_limit`, and `_idempotency_key`.

<Info>
  A successful collection returns a `task_id`. Continue with `socq_get_task` until the task succeeds, then read normalized records from `results.items`.
</Info>

See [MCP quickstart](/integrations/mcp) for the complete submission and polling flow.

`results_limit` defaults to 100 and accepts values from 1 through 2,000. Results use `resource="search"` and `type="pin"`.

## Completed Task Response

```json theme={"system"}
{
  "code": 200,
  "data": {
    "task_id": "A1B2C3D4E5F6G7H8",
    "status": "succeeded",
    "public_id": "pinterest/search",
    "result_count": 1,
    "credits_amount": 0.6,
    "results": {
      "limit": 50,
      "next_cursor": null,
      "has_more": false,
      "items": [{
        "id": "123456789",
        "platform": "pinterest",
        "resource": "search",
        "type": "pin",
        "url": "https://www.pinterest.com/pin/123456789/",
        "name": "Modern home office",
        "text": "A bright and practical workspace.",
        "author": {"id": "user_id", "username": "example", "name": "example", "url": "https://www.pinterest.com/example/"},
        "metrics": {"likes_count": 240, "comments_count": 12, "followers_count": 12500},
        "media": [{"type": "image", "url": "https://example.com/pin.jpg"}],
        "created_at": "2026-07-15T08:00:00",
        "collected_at": "2026-07-17T10:30:00",
        "extra": {"discovery_input": {"keyword": "home office ideas"}}
      }]
    }
  }
}
```


## OpenAPI

````yaml api-manual/agent-api/agent-api.json POST /v1/pinterest/search
openapi: 3.1.0
info:
  title: SocQ Agent API
  version: v1-063d1c96173a
  description: Asynchronous social data API generated from the SocQ Capability Registry.
servers:
  - url: https://api.socq.ai
security: []
paths:
  /v1/pinterest/search:
    post:
      tags:
        - pinterest
      summary: Pinterest Search API
      description: Pinterest Search API
      operationId: socq_pinterest_search
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              additionalProperties: false
              properties:
                query:
                  type: string
                  minLength: 1
                  description: Search query.
                results_limit:
                  type: integer
                  minimum: 1
                  maximum: 2000
              required:
                - query
      responses:
        '200':
          description: Task accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentSubmitResponse'
      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'
            idempotent_replay:
              type: boolean
          required:
            - task_id
            - status
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````