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

# Add a magnet



## OpenAPI

````yaml /api-reference/openapi.yaml post /v0/store/magnets
openapi: 3.0.3
info:
  title: Torrin API
  version: 1.0.0
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.en.html
  description: >
    Torrin's HTTP API has two halves:


    - The **native app API** under `/api` — the job engine, search,
    availability,
      bring-your-own-key debrid, bring-your-own-storage, Usenet, Cairn, and RSS. This is
      "torrin's own API"; it takes and returns torrin's own JSON.
    - Two **compatibility surfaces** for existing clients: a
    **RealDebrid-compatible** API
      under `/rest/1.0` (Stremio RD addons) and a **StremThru store** API under `/v0/store`
      (clients like Comet).

    All authenticated endpoints use your instance **API key** as a bearer token.
servers:
  - url: https://api.torrin.app
    description: Hosted torrin (api.torrin.app)
  - url: '{baseUrl}'
    description: Your self-hosted instance
    variables:
      baseUrl:
        default: https://api.torrin.app
        description: The base URL of your torrin instance
security:
  - bearerAuth: []
tags:
  - name: Account
    description: The authenticated user and account management.
  - name: Jobs
    description: The download engine. Add a source, track it, stream the result.
  - name: Search & availability
    description: Find content and check whether it's already cached.
  - name: Debrid keys
    description: Bring your own RealDebrid / AllDebrid / Premiumize / TorBox key (BYOK).
  - name: Storage
    description: Bring your own storage to stream from your own cloud (BYOS).
  - name: Usenet
    description: Usenet provider, indexer, search, and grabs.
  - name: Cairn
    description: Permanent Usenet-backed archive of cached content.
  - name: RSS
    description: Auto-add feeds.
  - name: RealDebrid-compatible
    description: RealDebrid API shapes under /rest/1.0, for RD clients and Stremio addons.
  - name: StremThru store
    description: StremThru store API under /v0/store, for clients like Comet.
  - name: Public
    description: Unauthenticated endpoints for signup and instance metadata.
paths:
  /v0/store/magnets:
    post:
      tags:
        - StremThru store
      summary: Add a magnet
      operationId: stAddMagnet
      parameters:
        - name: sid
          in: query
          description: Optional Stremio id for metadata.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - magnet
              properties:
                magnet:
                  type: string
      responses:
        '200':
          description: The magnet.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/StMagnet'
        '400':
          $ref: '#/components/responses/StoreBadRequest'
        '401':
          $ref: '#/components/responses/StoreUnauthorized'
        '429':
          $ref: '#/components/responses/StoreSlotLimit'
components:
  schemas:
    StMagnet:
      type: object
      properties:
        id:
          type: string
        hash:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
            - queued
            - downloading
            - downloaded
            - failed
        size:
          type: integer
          format: int64
        added_at:
          type: string
          format: date-time
        files:
          type: array
          items:
            type: object
            properties:
              index:
                type: integer
              name:
                type: string
              path:
                type: string
              size:
                type: integer
                format: int64
              link:
                type: string
    StoreError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
  responses:
    StoreBadRequest:
      description: Invalid request body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StoreError'
    StoreUnauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StoreError'
    StoreSlotLimit:
      description: Slot limit reached.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StoreError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Your instance API key as a bearer token: `Authorization: Bearer
        <api_key>`.

        `/rest/1.0` also accepts `?auth_token=`; `/v0/store` also accepts

        `X-StremThru-Store-Authorization: Bearer <api_key>`.

````