api.socialfetch.dev

{
  "description": "Standard success response envelope.",
  "properties": {
    "data": {
      "description": "Endpoint-specific response payload.",
      "properties": {
        "lookupStatus": {
          "description": "Outcome of the transcript lookup.",
          "enum": [
            "found",
            "not_found",
            "lookup_failed"
          ],
          "type": "string"
        },
        "transcript": {
          "description": "Transcript content when available for the resolved video.",
          "nullable": true,
          "properties": {
            "language": {
              "description": "Human-readable transcript language label when reported by the lookup.",
              "type": "string"
            },
            "plainText": {
              "description": "Full transcript text, typically derived from captions.",
              "type": "string"
            },
            "segments": {
              "description": "Timed transcript segments.",
              "items": {
                "description": "One timed transcript segment.",
                "properties": {
                  "endMs": {
                    "description": "Segment end offset in milliseconds.",
                    "minimum": 0,
                    "type": "integer"
                  },
                  "startMs": {
                    "description": "Segment start offset in milliseconds.",
                    "minimum": 0,
                    "type": "integer"
                  },
                  "text": {
                    "description": "Transcript segment text.",
                    "type": "string"
                  }
                },
                "required": [
                  "text",
                  "startMs",
                  "endMs"
                ],
                "type": "object"
              },
              "type": "array"
            }
          },
          "required": [
            "segments",
            "plainText",
            "language"
          ],
          "type": "object"
        },
        "video": {
          "description": "Video identity when the lookup resolved.",
          "nullable": true,
          "properties": {
            "id": {
              "description": "YouTube video id.",
              "minLength": 1,
              "type": "string"
            },
            "url": {
              "description": "Canonical public URL for the video.",
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "id",
            "url"
          ],
          "type": "object"
        }
      },
      "required": [
        "lookupStatus",
        "video",
        "transcript"
      ],
      "type": "object"
    },
    "meta": {
      "description": "Metadata describing the request and billing outcome.",
      "properties": {
        "cached": {
          "description": "True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.",
          "type": "boolean"
        },
        "creditsCharged": {
          "description": "Credits charged for this request.",
          "minimum": 0,
          "type": "integer"
        },
        "requestId": {
          "description": "Unique request identifier for tracing this API call.",
          "minLength": 1,
          "type": "string"
        },
        "version": {
          "description": "Public API version that served the response.",
          "enum": [
            "v1"
          ],
          "type": "string"
        }
      },
      "required": [
        "requestId",
        "creditsCharged",
        "version"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "type": "object"
}