본문으로 건너뛰기
KO
API 키 받기
문서 둘러보기

API 참조

관리 API 참고

계정, 키, 청구 및 작업에 대한 엔드 포인트를 검색합니다. 각 엔드포인트는 자체 인증 및 액세스 요구 사항을 나열합니다.

API 키로 계정 읽기

관리 API 기초 URL는 https://api.flashdata.dev/v2.입니다 이 무료 읽기는 현재 키와 계정 IDs 및 소유권을 반환합니다. 명령을 실행하기 전에 FLASHDATA_API_KEY를 설정합니다.

현재 키 확인 · Bash
curl --fail-with-body --silent --show-error --max-time 20 \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY first}" \
  'https://api.flashdata.dev/v2/api-access/identity'

성공에 HTTP 200를 기대합니다. 각 엔드포인트의 인증 라인 확인: dataApiKey는 X-API-Key를 사용합니다; cookieSession는 서명된 브라우저 세션을 사용합니다. Identity 응답 스키마

고객 OpenAPI 사양 다운로드. 쿼리, 작업, 계정, API 키 및 청구를 다룹니다.

Query 매개 변수 및 요청 코드는 문서화 Google 으로 YouTube API 참조.

인증 제도

팟캐스트관련 상품
dataApiKey

X-API-Key · header

FlashData API 열쇠. 작업 액세스는 키의 소스 범위에 제한됩니다.

cookieSession

__Host-fd_session · cookie

Opaque 웹 세션. 이 쿠키를 읽을 수 없습니다.

csrfToken

X-CSRF-Token · header

apiKey

agentRegistrationProof

암호화된 임의의 32-byte base64url 증거와 정확한 요청 BEFORE 전송; 동일한 증거와 몸만 복구. OAuth 토큰이 아닙니다.

agentSetupCredential

상태 및 청구서 작성에 대한 임시 설정 자격. 데이터 API 키가 아닙니다.

agentHandoffProof

소유자의 열쇠를 복구하고 임명을 인정하는 데 사용되는 증거. 데이터 쿼리에 전송하지 마십시오.

agentIdentityKey

정관적인 FlashData API 키, 에이전트 정체성에서만. 데이터 쿼리는 대신 X-API-Key를 사용합니다.

시스템

GET/health

서비스 건강

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 정상

200 응답 · application/json

Health

200 응답
{
  "$ref": "#/components/schemas/Health"
}
GET/status

공공 구성 요소 상태 요약 읽기

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 공공 상태 요약

공급 능력: Cache-Control

200 응답 · application/json

PublicStatus

200 응답
{
  "$ref": "#/components/schemas/PublicStatus"
}

오스

GET/oauth/requests/{requestId}

앱 권한 요청을 읽고 현재 세션에 바인딩

전체 세션이 필요합니다. 10 분 후에 만료됩니다. 응답은 아니 상점입니다.

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

requestId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}

응답하기

200 앱 권한 요청

200 응답 · application/json

OAuthConsent

200 응답
{
  "$ref": "#/components/schemas/OAuthConsent"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 자주 묻는 질문(FAQ)

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/oauth/requests/{requestId}

Approve 또는 deny 앱 권한 요청

전체 세션, CSRF 및 허용 원산지 필요. 요청을 한 번 반복합니다. 응답은 아니 상점입니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

requestId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "decision"
  ],
  "properties": {
    "decision": {
      "type": "string",
      "enum": [
        "approve",
        "deny"
      ]
    }
  }
}

응답하기

200 코드 또는 denial, 상태 및 발행인과 함께 등록된 클라이언트 콜백

200 응답 · application/json
200 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "redirectUrl"
  ],
  "properties": {
    "redirectUrl": {
      "type": "string",
      "format": "uri"
    }
  }
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 권한 요청을 사용할 수 없습니다. 새로운 연결을 시작합니다

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/register

FlashData 계정 만들기

제출된 약관 및 개인 정보 버전은 현재 공개된 법률 번들과 일치해야 합니다.

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json

RegisterRequest

스키마
{
  "$ref": "#/components/schemas/RegisterRequest"
}

응답하기

201 계정 생성; 이메일 확인 필수

공급 능력: Cache-Control, X-Request-Id

201 응답 · application/json

RegisterResponse

201 응답
{
  "$ref": "#/components/schemas/RegisterResponse"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 비율, concurrency, 일괄 처리, 또는 종료 작업 제한 초과

공급 능력: Retry-After

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

500 예기치 않은 내부 오류가 발생했습니다

500 응답 · application/problem+json

Problem

500 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/login

opaque 웹 세션 만들기

보안, HttpOnly `__Host-fd_session` 쿠키를 설정합니다. 계좌 개설 검증 대시보드에 대한 제한 email_verification 세션을 수신합니다. 검증된 계정은 이미 부여되지 않은 경우 로그인에 한 번의 평가 크레딧을받습니다. 활동 계정 아직 마이그레이션된 정체성을 하지 않는 한 전체 세션을받습니다. 현재 법적인 수용, 어느 경우 그것은 제한을받을 legal_acceptance 세션. 예약된 삭제 요청을 가진 계정 제한된 deletion_recovery 세션을받습니다. 의결을 받는 계정 processing/failed/completed이고, 중단된 계정은, 403를 받습니다.

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json

LoginRequest

스키마
{
  "$ref": "#/components/schemas/LoginRequest"
}

응답하기

200 인증 된

공급 능력: Set-Cookie, Cache-Control, X-Request-Id

200 응답 · application/json

LoginResponse

200 응답
{
  "$ref": "#/components/schemas/LoginResponse"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 로그인은 forbidden; Problem.code는 email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed, 또는 account_deleted입니다

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

423 계정 일시적으로 잠겨

공급 능력: Retry-After

423 응답 · application/problem+json

Problem

423 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 비율, concurrency, 일괄 처리, 또는 종료 작업 제한 초과

공급 능력: Retry-After

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/logout

현재 세션을 공개

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

204 세션 취소 및 쿠키 정리

공급 능력: Set-Cookie, Cache-Control, X-Request-Id

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/auth/me

현재 계정 및 사용자를 읽으십시오

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 현재 계정

공급 능력: Cache-Control, X-Request-Id

200 응답 · application/json

Account

200 응답
{
  "$ref": "#/components/schemas/Account"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/auth/csrf

현재 세션에 CSRF 토큰을 가져옵니다.

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 CSRF 토큰

공급 능력: Cache-Control, X-Request-Id

200 응답 · application/json
200 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "csrfToken"
  ],
  "properties": {
    "csrfToken": {
      "type": "string",
      "minLength": 32,
      "readOnly": true
    }
  }
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/email-verifications

이메일 확인 메시지 보내기

모든 syntactically 유효한 이메일의 경우, 계정이 누락된지 여부에 관계없이 동일한 응답을 반환, 종료, 활성, 중단, 또는 삭제. Eligible pending 계정은 resend cooldown 후 회전 한 번의 링크를받습니다.

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 320
    }
  }
}

응답하기

202 자주 묻는 질문 응답은 계정이 존재하는지 밝혀지지 않습니다.

공급 능력: Cache-Control, X-Request-Id

202 응답 · application/json
202 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "accepted"
  ],
  "properties": {
    "accepted": {
      "type": "boolean",
      "const": true
    }
  }
}

422 익명 인증 요청 검증 실패

공급 능력: Cache-Control, X-Request-Id

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 익명 인증률 제한 초과

공급 능력: Cache-Control, Retry-After, X-Request-Id

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

500 예기치 않은 익명 인증 오류가 발생했습니다

공급 능력: Cache-Control, X-Request-Id

500 응답 · application/problem+json

Problem

500 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 익명 인증 의존도는 일시적으로 사용할 수 없습니다

공급 능력: Cache-Control, X-Request-Id

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/email-verifications/confirm

이메일 확인 및 계정 활성화

Atomically는 한 번의 토큰을 소비하고 계정과 사용자를 활성화합니다. 기존 계정 및 시험 인증 규칙이 적용됩니다. signup Session 없이 사용자 로그는 명시적으로. 일치하는 signup Session을 수행하고 X-CSRF-Token는 동일한 검증된 계정의 회전 세션 쿠키를 받게 될 수 있습니다. 검증 토큰은 혼자 사용자에 서명하지 않습니다.

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json

TokenRequest

스키마
{
  "$ref": "#/components/schemas/TokenRequest"
}

응답하기

200 계정 활성화

공급 능력: Set-Cookie, Cache-Control, X-Request-Id

200 응답 · application/json

Account

200 응답
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Account"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "const": "active"
        },
        "emailVerified": {
          "const": true
        }
      }
    }
  ]
}

410 한 번의 토큰은 유효하지 않고 만료되고, 유효하지 않은, 이미 사용되거나 동시 확인 레이스를 잃습니다. Problem.code는 `token_unavailable`입니다.

공급 능력: Cache-Control, X-Request-Id

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 익명 인증 요청 검증 실패

공급 능력: Cache-Control, X-Request-Id

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 익명 인증률 제한 초과

공급 능력: Cache-Control, Retry-After, X-Request-Id

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

500 예기치 않은 익명 인증 오류가 발생했습니다

공급 능력: Cache-Control, X-Request-Id

500 응답 · application/problem+json

Problem

500 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 익명 인증 의존도는 일시적으로 사용할 수 없습니다

공급 능력: Cache-Control, X-Request-Id

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/email-verifications/session

이메일 확인 후 원래 가입 세션을 계속

허용된 원본과 CSRF 토큰이 실시간 암호 인증 세션에 바인딩됩니다. 해당 세션의 자체 계정이 확인될 때까지 반환된 금액은 다른 브라우저에서 검증을 포함하여 확인됩니다. Atomically signup Session을 수정하고 신선한 풀 또는 법적 계약 세션을 문제. 계정 ID, 이메일, 비밀번호 또는 검증 토큰을 허용하지 않거나 법적인 수용, 신용을 부여하지 않습니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false
}

응답하기

200 Signup 세션 회전

공급 능력: Set-Cookie, Cache-Control

200 응답 · application/json

LoginResponse

200 응답
{
  "$ref": "#/components/schemas/LoginResponse"
}

202 이메일 검증은 공개되지 않습니다; 새로운 세션 없음

공급 능력: Cache-Control

202 응답 · application/json
202 응답
{
  "type": "object",
  "required": [
    "pending"
  ],
  "additionalProperties": false,
  "properties": {
    "pending": {
      "type": "boolean",
      "const": true
    }
  }
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

500 예기치 않은 내부 오류가 발생했습니다

500 응답 · application/problem+json

Problem

500 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/password-resets

비밀번호 재설정 이메일을 요청

항상 같은 202 응답을 계정 존재 또는 라이프 사이클 상태에 관계없이 동기화 유효한 이메일 반환합니다. 해당 이용 후기에 달린 코멘트가 없습니다.

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 320
    }
  }
}

응답하기

202 자주 묻는 질문 응답은 계정이 존재하는지 밝혀지지 않습니다.

공급 능력: Cache-Control, X-Request-Id

202 응답 · application/json
202 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "accepted"
  ],
  "properties": {
    "accepted": {
      "type": "boolean",
      "const": true
    }
  }
}

422 익명 인증 요청 검증 실패

공급 능력: Cache-Control, X-Request-Id

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 익명 인증률 제한 초과

공급 능력: Cache-Control, Retry-After, X-Request-Id

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

500 예기치 않은 익명 인증 오류가 발생했습니다

공급 능력: Cache-Control, X-Request-Id

500 응답 · application/problem+json

Problem

500 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 익명 인증 의존도는 일시적으로 사용할 수 없습니다

공급 능력: Cache-Control, X-Request-Id

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/password-resets/confirm

새로운 암호를 설정하고 기존 세션을 수정

Atomically는 암호 재설정 토큰을 소비하고 새로운 Argon2id 자격 증명을 저장하고, 모든 기존 세션을 복제하고, 다른 암호 재설정 토큰을 유효하게합니다. 사용자를 로그인하거나 세션을 만들지 않습니다.

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json

Password

스키마
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "token",
    "password"
  ],
  "properties": {
    "token": {
      "type": "string",
      "minLength": 32,
      "maxLength": 256,
      "writeOnly": true
    },
    "password": {
      "$ref": "#/components/schemas/Password"
    }
  }
}

응답하기

204 비밀번호 업데이트; 기존 세션 revoked

공급 능력: Cache-Control, X-Request-Id

410 한 번의 토큰은 유효하지 않고 만료되고, 유효하지 않은, 이미 사용되거나 동시 확인 레이스를 잃습니다. Problem.code는 `token_unavailable`입니다.

공급 능력: Cache-Control, X-Request-Id

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 익명 인증 요청 검증 실패

공급 능력: Cache-Control, X-Request-Id

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 익명 인증률 제한 초과

공급 능력: Cache-Control, Retry-After, X-Request-Id

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

500 예기치 않은 익명 인증 오류가 발생했습니다

공급 능력: Cache-Control, X-Request-Id

500 응답 · application/problem+json

Problem

500 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 익명 인증 의존도는 일시적으로 사용할 수 없습니다

공급 능력: Cache-Control, X-Request-Id

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/auth/sessions

현재 사용자를 위한 Active sessions 목록

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 학회소개

공급 능력: Cache-Control, X-Request-Id

200 응답 · application/json

Session

200 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Session"
      }
    }
  }
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/auth/sessions

현재를 제외한 모든 세션을 공개

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

204 다른 세션은 개정

공급 능력: Cache-Control, X-Request-Id

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/auth/sessions/{sessionId}

한 세션을 읽다

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

sessionId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^ses_"
}

응답하기

204 세션이 변경되었습니다. 현재 세션이 된 경우, 쿠키가 명확하게됩니다.

공급 능력: Set-Cookie, Cache-Control, X-Request-Id

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/re-authenticate

민감한 작업에 대한 현재 암호를 검증

현재 서버 측 세션에 대한 단기적인 최근의 증거를 기록합니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "password"
  ],
  "properties": {
    "password": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    }
  }
}

응답하기

200 세션은 최근 인증

공급 능력: Cache-Control, X-Request-Id

200 응답 · application/json

Reauthentication

200 응답
{
  "$ref": "#/components/schemas/Reauthentication"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 비율, concurrency, 일괄 처리, 또는 종료 작업 제한 초과

공급 능력: Retry-After

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/auth/password

비밀번호 변경 및 현재 세션 회전

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json

Password

스키마
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "currentPassword",
    "newPassword"
  ],
  "properties": {
    "currentPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    },
    "newPassword": {
      "$ref": "#/components/schemas/Password"
    },
    "revokeOtherSessions": {
      "type": "boolean",
      "default": true
    }
  }
}

응답하기

204 비밀번호 변경; 현재 세션이 회전 및 기타 세션이 요청시 수정됨

공급 능력: Set-Cookie, Cache-Control, X-Request-Id

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

계좌정보

GET/oauth/connections

현재 계정의 연결된 앱 목록

전체 세션이 필요합니다. 계정이 연결된 앱이 없을 때 빈. 응답은 아니 상점입니다.

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 Connected apps

200 응답 · application/json

OAuthConnection

200 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OAuthConnection"
      }
    }
  }
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/oauth/connections/{grantId}

연결된 앱과 전용 API 키 복제

전체 세션, CSRF 및 허용 원산지 필요. 계정 소유권은 시행됩니다. 응답은 아니 상점입니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

grantId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}

응답하기

204 인증 변경

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/account

계정 설정

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 계좌정보

200 응답 · application/json

Account

200 응답
{
  "$ref": "#/components/schemas/Account"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/account

Update profile 설정

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json

UpdateAccountRequest

스키마
{
  "$ref": "#/components/schemas/UpdateAccountRequest"
}

응답하기

200 업데이트 된 계정

200 응답 · application/json

Account

200 응답
{
  "$ref": "#/components/schemas/Account"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/account

일정 계정 삭제 및 기존 세션 및 API Keys를 수정

Administrator 계정은 deletion이 예정되기 전에 감사된 작업 흐름을 통해 보상된 플랫폼 역할을 해야 합니다. 독특한 활성 탈렛 요청은 자연 idempotency 경계입니다. Concurrent 인증된 일정은 동일한 요청을 반환합니다. 세션 재발행 후, 손실된 응답은 deletion_recovery 모드로 로그인하여 GET /account/deletion를 읽습니다. 재발행 세션은 재생할 수 없습니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "password",
    "confirmation"
  ],
  "properties": {
    "password": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    },
    "confirmation": {
      "type": "string",
      "const": "DELETE"
    }
  }
}

응답하기

202 예정된 삭제; 활동 세션 및 키가 재개

202 응답 · application/json

AccountDeletionRequest

202 응답
{
  "$ref": "#/components/schemas/AccountDeletionRequest"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/account/deletion

현재 계정 삭제 요청 읽기

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 현재 deletion 요구

200 응답 · application/json

AccountDeletionRequest

200 응답
{
  "$ref": "#/components/schemas/AccountDeletionRequest"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/account/deletion

우아한 기간 동안 예약된 삭제 취소

예약된 비교 및 세트를 사용합니다. 프로세서 레이스는 409를 반환합니다; 성공 후 복구 세션은 회전하고 오래된 전환을 재생할 수 없습니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

204 삭제 취소, 계정 재 활성화, 및 복구 세션은 법적 수용 게이트에 따라 회전

공급 능력: Set-Cookie, Cache-Control, X-Request-Id

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/account/legal-acceptances

Accept는 현재 공개된 약관 및 개인 정보 버전

법적인 수용을 승인하고 마이그레이션 게이트를 명확하게하고 세션을 회전시킵니다. Stale 제출 된 버전은 거부됩니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json

LegalAcceptanceRequest

스키마
{
  "$ref": "#/components/schemas/LegalAcceptanceRequest"
}

응답하기

200 법률 합격 기록 및 세션은 풀 모드로 회전

공급 능력: Set-Cookie, Cache-Control, X-Request-Id

200 응답 · application/json

LoginResponse

200 응답
{
  "$ref": "#/components/schemas/LoginResponse"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

관련 기사

GET/onboarding

resumable onboarding 진도 읽기

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 현재 onboarding 국가

공급 능력: Cache-Control, X-Request-Id

200 응답 · application/json

OnboardingProgress

200 응답
{
  "$ref": "#/components/schemas/OnboardingProgress"
}

401 인증 필요 또는 잘못된

공급 능력: Cache-Control, X-Request-Id

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

500 예기치 않은 내부 오류가 발생했습니다

공급 능력: Cache-Control, X-Request-Id

500 응답 · application/problem+json

Problem

500 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필요한 의존성 또는 내장 기록은 일시적으로 사용할 수 없습니다.

공급 능력: Cache-Control, X-Request-Id

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/onboarding

뒤로 이동할 수 있는 진행을 허용하지 않고 미리

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json

UpdateOnboardingRequest

스키마
{
  "$ref": "#/components/schemas/UpdateOnboardingRequest"
}

응답하기

200 업데이트된 onboarding 상태

공급 능력: Cache-Control, X-Request-Id

200 응답 · application/json

OnboardingProgress

200 응답
{
  "$ref": "#/components/schemas/OnboardingProgress"
}

401 인증 필요 또는 잘못된

공급 능력: Cache-Control, X-Request-Id

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

공급 능력: Cache-Control, X-Request-Id

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

공급 능력: Cache-Control, X-Request-Id

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

공급 능력: Cache-Control, X-Request-Id

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

500 예기치 않은 내부 오류가 발생했습니다

공급 능력: Cache-Control, X-Request-Id

500 응답 · application/problem+json

Problem

500 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필요한 의존성 또는 내장 기록은 일시적으로 사용할 수 없습니다.

공급 능력: Cache-Control, X-Request-Id

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}

개요

GET/overview

계정 대시보드 집계 읽기

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 회계감사

공급 능력: Cache-Control, X-Request-Id

200 응답 · application/json

ConsoleOverview

200 응답
{
  "$ref": "#/components/schemas/ConsoleOverview"
}

401 인증 필요 또는 잘못된

공급 능력: Cache-Control, X-Request-Id

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

500 예기치 않은 내부 오류가 발생했습니다

공급 능력: Cache-Control, X-Request-Id

500 응답 · application/problem+json

Problem

500 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필요한 의존성 또는 내장 기록은 일시적으로 사용할 수 없습니다.

공급 능력: Cache-Control, X-Request-Id

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}

API Keys

GET/api-access/identity

현재 API 키 소유권을 검증하고 읽음을 반복

무료 헤더 전용 API 키 읽기. 공개 account/key IDs 및 권한 소유권을 반환합니다. 요구 몸 없음. 기존 /api-access 메타데이터 응답을 변경하지 않습니다. 120/minute 계정 읽기 제한을 공유합니다. 실패는 불용성에 닫힙니다; 열쇠 접두사, 계획, 또는 국부적으로 국가에서 소유권을 infer하지 마십시오. 쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다.

인증: dataApiKey

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 현재 API 키 소유권을 검증하고 읽음을 반복

200 응답 · application/json

APIKeyIdentity

200 응답
{
  "$ref": "#/components/schemas/APIKeyIdentity"
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-keys

API 키 메타데이터 목록

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 비밀 없는 API Keys

200 응답 · application/json

ApiKey

200 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ApiKey"
      }
    }
  }
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/api-keys

API Key를 생성하고 한 번 비밀을 알립니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

Idempotency-Key · header · *필수

스키마
스키마
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

요청 몸 · *필수

스키마 · application/json

CreateApiKeyRequest

스키마
{
  "$ref": "#/components/schemas/CreateApiKeyRequest"
}

응답하기

201 Created; 동일한 idempotent 재생은 5 분 동안 동일한 암호화 된 응답을 반환 할 수 있습니다.

201 응답 · application/json

ApiKeyCreated

201 응답
{
  "$ref": "#/components/schemas/ApiKeyCreated"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/api-keys/{keyId}

API 키에 복사

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

keyId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^key_"
}

응답하기

204 댓글 RSS

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/api-keys/{keyId}/rotate

교체 키 및 일정 이전 키 재발급 만들기

새로운 키를 생성하고 revokeOldAt까지 오래된 키 활성화 유지. 기본적으로, 오버랩은 24 시간을 지속하거나 이전 키가 만료 될 때까지, 이는 이전입니다. revokeOldAt는 7 일 안에 미래에 있어야 하고, 오래된 열쇠 expiry 보다는 나중에 없습니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

keyId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^key_"
}

Idempotency-Key · header · *필수

스키마
스키마
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

요청 몸 · 옵션 정보

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "revokeOldAt": {
      "type": "string",
      "format": "date-time",
      "description": "Optional old-key revocation time; defaults to 24 hours and cannot exceed seven days or the old key expiry."
    }
  }
}

응답하기

201 교체 생성; 한 번 반환된 비밀

201 응답 · application/json

ApiKeyCreated

201 응답
{
  "$ref": "#/components/schemas/ApiKeyCreated"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-access

API 키의 허가 된 소스 및 결과 소스 호출을 읽으십시오.

X-API-Key 인증 반환 만 부여 된 공공 소스 이름과 구성 된 서명 스토리지 기원 (null if 사용 가능). 계정 없음 ID, 키 ID, 비밀 또는 저장 자격은 반환됩니다. Local MCP는 모든 도구 발견 및 통화 전에이 엔드포인트를 다시 유효성 검사합니다. cached 결과를 읽습니다. 질문 모수 또는 요구 몸은 받아들여집니다. 모든 /api-access 경로는 클라이언트 IP 당 분 당 120 요구 및 반환을 공유합니다 Cache-Control 개인, 아니 상점. 정상적인 열쇠는 아직도 아직도 말한 추적하.

인증: dataApiKey

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 공인 된 공공 소스 및 결과 원산지

200 응답 · application/json

ApiAccess

200 응답
{
  "$ref": "#/components/schemas/ApiAccess"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 너무 많은 계정 읽기; 속도 제한 창 후 재시

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}

에이전트 연결

GET/agent-connections/capabilities

프로토콜 2 내장 사용 가능

쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다.

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 프로토콜 2 내장 사용 가능

200 응답 · application/json

AgentCapabilities

200 응답
{
  "$ref": "#/components/schemas/AgentCapabilities"
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/registrations

임시 API-key 연결을 만들거나 복구하십시오

POST의 앞에 등록 증거 그리고 정확한 입력을 주장하십시오. 동일한 증거와 몸은 동일한 예심을 회복합니다; 입력 수확량 충돌을 바꾸십시오. 임시 체험: 1 신용, 72 시간, 1 request/second의 배치 크기 1. Source range limits는 서버의 권한이 남아 있습니다. 쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다.

인증: agentRegistrationProof

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json

AgentRegistrationRequest

스키마
{
  "$ref": "#/components/schemas/AgentRegistrationRequest"
}

응답하기

201 임시 API-key 연결을 만들거나 복구하십시오

201 응답 · application/json

AgentRegistration

201 응답
{
  "$ref": "#/components/schemas/AgentRegistration"
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/owned

웹 사이트

쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다. 브라우저 소유 작업. 전체 검증된 세션이 필요합니다. 콜러는 API 키 또는 증거를 대체하지 않아야 합니다.

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 웹 사이트

200 응답 · application/json

AgentConnection

200 응답
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connections": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AgentConnection"
      }
    }
  },
  "required": [
    "connections"
  ]
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/{connectionId}

임시 연결 상태를 읽으십시오

쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다.

인증: agentSetupCredential

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

connectionId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

응답하기

200 임시 연결 상태를 읽으십시오

200 응답 · application/json

AgentConnectionResponse

200 응답
{
  "$ref": "#/components/schemas/AgentConnectionResponse"
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/agent-connections/{connectionId}

관련 링크

쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다. 브라우저 소유 작업. 전체 검증된 세션이 필요합니다. 콜러는 API 키 또는 증거를 대체하지 않아야 합니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

connectionId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · *필수

스키마
스키마
{
  "type": "string"
}

X-CSRF-Token · header · *필수

스키마
스키마
{
  "type": "string"
}

응답하기

204 관련 링크

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/{connectionId}/identity

연결에 대한 현재 데이터 API 키 검증

쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다.

인증: agentIdentityKey

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

connectionId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

응답하기

200 연결에 대한 현재 데이터 API 키 검증

200 응답 · application/json

AgentConnectionResponse

200 응답
{
  "$ref": "#/components/schemas/AgentConnectionResponse"
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/{connectionId}/onboarding

복구 가능한 온보딩 상태

쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다.

인증: agentHandoffProof

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

connectionId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

응답하기

200 복구 가능한 온보딩 상태

200 응답 · application/json

AgentOnboardingStatus

200 응답
{
  "$ref": "#/components/schemas/AgentOnboardingStatus"
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/{connectionId}/claims

브라우저의 승인 청구

신뢰할 수있는 FlashData 웹 소스에서 claimPath를 열고 코드를 별도로 표시하십시오. 자격 증명 또는 URL의 확인 코드가 없습니다. 쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다.

인증: agentSetupCredential

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

connectionId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "properties": {},
  "required": []
}

응답하기

201 브라우저의 승인 청구

201 응답 · application/json

AgentClaim

201 응답
{
  "$ref": "#/components/schemas/AgentClaim"
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/claims/{claimId}/confirm

확인된 브라우저 세션의 클레임 코드 확인

쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다. 브라우저 소유 작업. 전체 검증된 세션이 필요합니다. 콜러는 API 키 또는 증거를 대체하지 않아야 합니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

claimId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · *필수

스키마
스키마
{
  "type": "string"
}

X-CSRF-Token · header · *필수

스키마
스키마
{
  "type": "string"
}

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "code": {
      "type": "string",
      "pattern": "^\\d{8}$"
    }
  },
  "required": [
    "code"
  ]
}

응답하기

200 확인된 브라우저 세션의 클레임 코드 확인

200 응답 · application/json

AgentBrowserClaim

200 응답
{
  "$ref": "#/components/schemas/AgentBrowserClaim"
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/claims/{claimId}

브라우저 세션에서 확인된 청구를 읽으십시오

쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다. 브라우저 소유 작업. 전체 검증된 세션이 필요합니다. 콜러는 API 키 또는 증거를 대체하지 않아야 합니다.

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

claimId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}

응답하기

200 브라우저 세션에서 확인된 청구를 읽으십시오

200 응답 · application/json

AgentClaimView

200 응답
{
  "$ref": "#/components/schemas/AgentClaimView"
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/claims/{claimId}/approve

적용 범위 및 계정 균형 자금 감소

쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다. 브라우저 소유 작업. 전체 검증된 세션이 필요합니다. 콜러는 API 키 또는 증거를 대체하지 않아야 합니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

claimId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · *필수

스키마
스키마
{
  "type": "string"
}

X-CSRF-Token · header · *필수

스키마
스키마
{
  "type": "string"
}

요청 몸 · *필수

스키마 · application/json

AgentApproval

스키마
{
  "$ref": "#/components/schemas/AgentApproval"
}

응답하기

200 적용 범위 및 계정 균형 자금 감소

200 응답 · application/json

AgentConnection

200 응답
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "handoff": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "status": {
          "type": "string"
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "status",
        "expiresAt"
      ]
    }
  },
  "required": [
    "connection",
    "handoff"
  ]
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/{connectionId}/handoff

승인 된 소유자 API 키 복구

일정한 열쇠는 임명 ACK까지 24 시간에서 만료됩니다. Persist atomically, 신선한 공정에 재부하 및 ACK 이전에 정체성을 확인합니다. 반복된 납품은 동일한 후보자를 복구합니다; 확인된 납품은 credentials 없이 영수증을 돌려줍니다. 쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다.

인증: agentHandoffProof

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

connectionId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "properties": {},
  "required": []
}

응답하기

200 승인 된 소유자 API 키 복구

200 응답 · application/json

AgentHandoff

200 응답
{
  "$ref": "#/components/schemas/AgentHandoff"
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/{connectionId}/handoff/ack

Acknowledge 확인 소유자 키 설치

Caller는 이미 후보자를 저장하고 독립적으로 신선한 과정에서 확인해야합니다. 성공적인 ACK 마크 설치, 후보 키 만료 제거 및 복구 가능한 자격 자료를 삭제. 반복된 ACK는 idempotent입니다. 쿼리 매개 변수가 허용되지 않습니다. 응답은 없습니다. 에이전트 경로는 관리 전용 및 기능 통합; 배포는 404를 반환할 수 있습니다. X-API-Key는 대리인 노선에 금지됩니다.

인증: agentHandoffProof

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

connectionId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apiKey": {
      "type": "string"
    }
  },
  "required": [
    "apiKey"
  ]
}

응답하기

200 Acknowledge 확인 소유자 키 설치

200 응답 · application/json

AgentHandoff

200 응답
{
  "$ref": "#/components/schemas/AgentHandoff"
}

400 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

400 응답 · application/problem+json

Problem

400 응답
{
  "$ref": "#/components/schemas/Problem"
}

401 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

429 응답 · application/problem+json

Problem

429 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 요청이 거부되었습니다. Problem 코드를 확인하세요. 상태를 변경하는 요청을 확인 없이 다시 실행하지 마세요.

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}

학회소개

GET/catalog/sources

계정 별 가격 없이 공공 소스 기능 목록

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 공공 소스 카탈로그

공급 능력: Cache-Control

200 응답 · application/json

DataSource

200 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DataSource"
      }
    }
  }
}
GET/plans

공개 USD 계획 및 가격 목록

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 공공 계획 카탈로그

공급 능력: Cache-Control

200 응답 · application/json

PlanCatalog

200 응답
{
  "$ref": "#/components/schemas/PlanCatalog"
}
GET/legal/current

Signup에 필요한 현재 이용 약관 및 개인 정보 버전 읽기

인증: 공개

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 현재 법률 버전 카탈로그

공급 능력: Cache-Control

200 응답 · application/json

PublicLegalVersions

200 응답
{
  "$ref": "#/components/schemas/PublicLegalVersions"
}

Billing

GET/billing/subscription

효과적인 Stripe 구독 읽기

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 구독 또는 PAYG 제목

200 응답 · application/json

Subscription

200 응답
{
  "$ref": "#/components/schemas/Subscription"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/checkout-sessions

Stripe-hosted Checkout 세션 만들기

구독 및 발행 크레딧 팩 사용 priceId. amountMinor 대신 (USD 센트, $10에서 $999,999.99로 사용 가능) 서버는 고정 신용 값에서 크레딧을 계산하고 개인 시간 줄무늬 가격을 만듭니다. 제품, 공급자 가격, 통화, 성공 URL 및 취소 URL는 브라우저에서 허용되지 않습니다. 신용은 견적 된 금액에 대한 검증 된 유료 이벤트 후만 부여됩니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

Idempotency-Key · header · *필수

스키마
스키마
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

요청 몸 · *필수

스키마 · application/json
스키마
{
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "priceId"
      ],
      "properties": {
        "priceId": {
          "type": "string",
          "pattern": "^prc_"
        },
        "purchaseType": {
          "type": "string",
          "enum": [
            "subscription",
            "top_up"
          ],
          "default": "subscription"
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "amountMinor",
        "purchaseType"
      ],
      "properties": {
        "amountMinor": {
          "type": "integer",
          "minimum": 1000,
          "maximum": 99999999,
          "description": "Custom top-up amount in USD cents."
        },
        "purchaseType": {
          "type": "string",
          "const": "top_up"
        }
      }
    }
  ]
}

응답하기

201 연락처

201 응답 · application/json

HostedSession

201 응답
{
  "$ref": "#/components/schemas/HostedSession"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

502 업스트림 공급자 실패

502 응답 · application/problem+json

Problem

502 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 빌링 카탈로그 또는 공급자는 구성되지 않거나 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/subscription-changes

현재 Stripe 구독을 더 높은 출판 가격으로 업그레이드하십시오.

서버는 FlashData 가격이 현재 livemode, USD-denominated, recurring, 동일한 간격 및 현재 구독 가격보다 훨씬 비싸다는 것을 증명합니다. 제품, 공급자 가격, 통화 및 등록 옵션은 브라우저에서 허용되지 않습니다. 검증된 제공업체 이벤트가 진행된 후만 로컬 제목과 크레딧 변경이 진행됩니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

Idempotency-Key · header · *필수

스키마
스키마
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "priceId"
  ],
  "properties": {
    "priceId": {
      "type": "string",
      "pattern": "^prc_"
    }
  }
}

응답하기

201 Stripe에 제출된 구독 변경

201 응답 · application/json

SubscriptionChange

201 응답
{
  "$ref": "#/components/schemas/SubscriptionChange"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

502 업스트림 공급자 실패

502 응답 · application/problem+json

Problem

502 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 빌링 카탈로그 또는 공급자는 구성되지 않거나 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/portal-sessions

Stripe 고객 포털 세션 만들기

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

Idempotency-Key · header · *필수

스키마
스키마
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

응답하기

201 Stripe 고객 포털 세션

201 응답 · application/json

HostedSession

201 응답
{
  "$ref": "#/components/schemas/HostedSession"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

502 업스트림 공급자 실패

502 응답 · application/problem+json

Problem

502 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 빌링 카탈로그 또는 공급자는 구성되지 않거나 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/subscription-cancellation

현재 유료 구독의 일정 또는 취소 취소

cancelAtPeriodEnd를 true로 설정하면 현재 청구 기간에 취소됩니다. false는 구독을 유지합니다. 확인된 Stripe 구독 이벤트 후 제목 업데이트. 이 엔드포인트는 즉시 취소하거나 환불을 할 수 없습니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

Idempotency-Key · header · *필수

스키마
스키마
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "cancelAtPeriodEnd"
  ],
  "properties": {
    "cancelAtPeriodEnd": {
      "type": "boolean"
    }
  }
}

응답하기

202 Stripe에 제출 된 취소 업데이트

202 응답 · application/json

SubscriptionCancellationChange

202 응답
{
  "$ref": "#/components/schemas/SubscriptionCancellationChange"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

502 업스트림 공급자 실패

502 응답 · application/problem+json

Problem

502 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 빌링 카탈로그 또는 공급자는 구성되지 않거나 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/billing/invoices

Stripe 송장 계획 목록

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

cursor · query · 옵션 정보

스키마
스키마
{
  "type": "string",
  "maxLength": 512
}

limit · query · 옵션 정보

스키마
스키마
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

응답하기

200 청구서

200 응답 · application/json

Invoice · Page

200 응답
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Page"
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Invoice"
          }
        }
      }
    }
  ]
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/billing/payments

계정-경쟁 최고-업 및 환불 결제 계획 목록

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

cursor · query · 옵션 정보

스키마
스키마
{
  "type": "string",
  "maxLength": 512
}

limit · query · 옵션 정보

스키마
스키마
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

응답하기

200 공급자 비밀 없이 일회성 지불 역사

200 응답 · application/json

BillingPaymentPage

200 응답
{
  "$ref": "#/components/schemas/BillingPaymentPage"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

크레딧

GET/api-access/balance

API 키를 사용하여 라이브 계정 잔액을 읽으십시오

계정의 모든 API 키에 의해 공유된 현재 신용 잔액을 읽으십시오. Active 예약은 가능한 잔액을 줄일 수 있습니다. 이 요청은 크레딧이 아니고 쿼리 매개 변수 또는 신체가 필요하지 않습니다. 응답은 개인이며 캐시되지 않습니다. 계정 읽기 속도 제한이 적용됩니다.

인증: dataApiKey

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 표시된 잔액 및 비 부정 사용 가능한 크레딧

200 응답 · application/json

ApiAccessBalance

200 응답
{
  "$ref": "#/components/schemas/ApiAccessBalance"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 너무 많은 계정 읽기; 속도 제한 창 후 재시

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-access/pricing

API 키에 의해 허가 된 소스에 대한 실제 계정 가격을 읽으십시오

API 키에 의해 허용된 소스에 대한 계정 요금을 읽으십시오. null 가격은 소스가 사용할 수 없다는 것을 의미합니다. request_count는 쿼리를 계산하고 반품되지 않습니다. 다운로드 비율은 TB (10^12 바이트) 당 입니다. 견적은 크레딧 또는 용량을 예약하지 않습니다. 이 요청은 크레딧이 없습니다. 응답은 개인이며 캐시되지 않습니다. 계정 읽기 속도 제한이 적용됩니다.

인증: dataApiKey

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

source · query · 옵션 정보

이 키에 부여 된 소스; 모든 권한을 읽는 omit.

스키마

ApiAccessSource

스키마
{
  "$ref": "#/components/schemas/ApiAccessSource"
}

request_count · query · 옵션 정보

Decimal integer 호출의 수; 다운로드 크기를 추정하지 않습니다.

스키마
스키마
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100000,
  "default": 1
}

응답하기

200 계정 계획 및 소스 별 가격

200 응답 · application/json

ApiAccessPricing

200 응답
{
  "$ref": "#/components/schemas/ApiAccessPricing"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 너무 많은 계정 읽기; 속도 제한 창 후 재시

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-access/limits

API 키를 사용하여 계정 계획 제한 및 현재 종료 작업을 읽으십시오.

concurrency, 일괄 크기 및 pending-job 제한을 읽고, 현재의 pending 카운트. 이 값은 계획 요청을 돕지만 용량을 예약하지 않습니다. 이 요청은 크레딧이 아니고 쿼리 매개 변수 또는 신체가 필요하지 않습니다. 응답은 개인이며 캐시되지 않습니다. 계정 읽기 속도 제한이 적용됩니다.

인증: dataApiKey

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 플랜 천장 및 현재 보류 수

200 응답 · application/json

ApiAccessLimits

200 응답
{
  "$ref": "#/components/schemas/ApiAccessLimits"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 너무 많은 계정 읽기; 속도 제한 창 후 재시

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/usage

API 키에 의해 허가 된 소스에 대한 계정 사용 읽기

무료 읽기, X-API-Key에서만 인증. 모든 계정 키를 포함하지만 호출 키에 부여 된 소스. 쿼리 텍스트를 반환하지 않습니다, 키, 지불 세부사항 또는 다른 계정. 7 일로 기본; 최대 31 일. 날짜는 UTC Z 타임스탬프를 사용해야합니다. 에서 포함 하 고 독점; 둘 다 분에 돌리기. 혼자서, + 7 일에서 기본적으로. 다음 분의 시작은 없습니다. 집계는 결국 일관성; 심지어 updating=false는 모든 최근 이벤트를 보장하지 않습니다. 한계를 읽으십시오: 클라이언트 IP 당 분 당 60 요구.

인증: dataApiKey

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

source · query · 옵션 정보

호출 키에 부여 된 정확한 카탈로그 소스; omitted는 모든 권한을 부여.

스키마
스키마
{
  "type": "string",
  "enum": [
    "google_search",
    "google_images",
    "google_news",
    "google_shopping",
    "google_videos",
    "google_places",
    "youtube_search",
    "youtube_search_extended",
    "youtube_metadata",
    "youtube_transcript",
    "youtube_captions",
    "youtube_trainability",
    "youtube_channel",
    "youtube_suggestions",
    "youtube_download"
  ]
}

from · query · 옵션 정보

스키마
스키마
{
  "type": "string",
  "format": "date-time"
}

to · query · 옵션 정보

스키마
스키마
{
  "type": "string",
  "format": "date-time"
}

응답하기

200 Scoped 요청은 신선도 정보로 계산되고 크레딧을 청구합니다.

200 응답 · application/json

ApiKeyUsage

200 응답
{
  "$ref": "#/components/schemas/ApiKeyUsage"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

429 너무 많은 사용 읽기; 속도 제한 창 후 재시

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/credits/balance

현재 사용 가능 및 예약 크레딧 읽기

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 신용 잔액

200 응답 · application/json

CreditBalance

200 응답
{
  "$ref": "#/components/schemas/CreditBalance"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/credits/policy

효과적인 계정 신용 보조금 및 충전 정책을 읽으십시오

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 효과적인 신용 정책

200 응답 · application/json

CreditPolicy

200 응답
{
  "$ref": "#/components/schemas/CreditPolicy"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/credits/transactions

List 크레딧 원장 항목

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

cursor · query · 옵션 정보

스키마
스키마
{
  "type": "string",
  "maxLength": 512
}

limit · query · 옵션 정보

스키마
스키마
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

type · query · 옵션 정보

스키마

CreditEntryType

스키마
{
  "$ref": "#/components/schemas/CreditEntryType"
}

응답하기

200 Ledger 항목

200 응답 · application/json

CreditTransaction · Page

200 응답
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Page"
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CreditTransaction"
          }
        }
      }
    }
  ]
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

시험 크레딧

GET/trial-credit-request

시험 크레딧 자격 및 계정의 평생 요청 읽기

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 현재 자격, 구성 보조금 및 요청 상태

공급 능력: Cache-Control

200 응답 · application/json

TrialCreditState

200 응답
{
  "$ref": "#/components/schemas/TrialCreditState"
}

401 인증 필요 또는 잘못된

공급 능력: Cache-Control, X-Request-Id

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

500 예기치 않은 내부 오류가 발생했습니다

공급 능력: Cache-Control, X-Request-Id

500 응답 · application/problem+json

Problem

500 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필요한 의존성 또는 내장 기록은 일시적으로 사용할 수 없습니다.

공급 능력: Cache-Control, X-Request-Id

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/trial-credit-request

계정의 한 평생 시험 크레딧 요청 제출

시험 금액과 사용 사례는 요청을 제출할 때 저장됩니다.

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

Idempotency-Key · header · *필수

스키마
스키마
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

요청 몸 · 옵션 정보

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false
}

응답하기

201 이메일 공급자와 상관없이, 공인된 인증된 계정으로 인증된 시험 크레딧 요청

공급 능력: Cache-Control

201 응답 · application/json

TrialCreditState

201 응답
{
  "$ref": "#/components/schemas/TrialCreditState"
}

401 인증 필요 또는 잘못된

공급 능력: Cache-Control, X-Request-Id

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

403 인증되지 않은, 또는 CSRF 검증 실패

공급 능력: Cache-Control, X-Request-Id

403 응답 · application/problem+json

Problem

403 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

공급 능력: Cache-Control, X-Request-Id

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

공급 능력: Cache-Control, X-Request-Id

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

500 예기치 않은 내부 오류가 발생했습니다

공급 능력: Cache-Control, X-Request-Id

500 응답 · application/problem+json

Problem

500 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필요한 의존성 또는 내장 기록은 일시적으로 사용할 수 없습니다.

공급 능력: Cache-Control, X-Request-Id

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}

제품 정보

GET/delivery/webhooks

저장된 완료 콜백 URLs 목록

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

응답하기

200 콜백 URLs

200 응답 · application/json

DeliveryWebhook

200 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeliveryWebhook"
      }
    }
  }
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/delivery/webhooks

완료 콜백 저장 URL

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json

CreateDeliveryWebhookRequest

스키마
{
  "$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}

응답하기

201 으로

201 응답 · application/json

DeliveryWebhook

201 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "webhook"
  ],
  "properties": {
    "webhook": {
      "$ref": "#/components/schemas/DeliveryWebhook"
    }
  }
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/delivery/webhooks/{webhookId}

완료 콜백 URL 제거

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

webhookId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}

응답하기

204 제품 정보

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}
POST/delivery/webhooks/{webhookId}/test

샘플 다운로드 완료 payload 보내기

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

webhookId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}

응답하기

200 시험 시도

200 응답 · application/json

DeliveryWebhook

200 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "statusCode",
    "webhook"
  ],
  "properties": {
    "statusCode": {
      "type": "integer",
      "minimum": 0
    },
    "webhook": {
      "$ref": "#/components/schemas/DeliveryWebhook"
    }
  }
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

작업

제출, 상태 및 결과 예시, 참조 Realtime 및 동기화 · Batch 요청.

GET/jobs

현재 작업 공간에 대한 데이터 API 작업 목록

Cursor-paginated 활성 및 아카이브 역사. 마지막 7 일에 기본; 각 UTC 날짜 범위는 31 일로 제한됩니다. 가격과 가격의 차이를 고려한 가격입니다. Summaries는 비동기적으로 유지되며, ingestion을 지연시킬 수 있습니다.

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

cursor · query · 옵션 정보

스키마
스키마
{
  "type": "string",
  "minLength": 1,
  "maxLength": 512
}

limit · query · 옵션 정보

스키마
스키마
{
  "type": "integer",
  "minimum": 1,
  "maximum": 50
}

source · query · 옵션 정보

스키마
스키마
{
  "type": "string",
  "pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}

status · query · 옵션 정보

스키마
스키마
{
  "type": "string",
  "enum": [
    "completed",
    "failed",
    "pending",
    "processing"
  ]
}

mode · query · 옵션 정보

스키마
스키마
{
  "type": "string",
  "enum": [
    "async",
    "batch",
    "realtime"
  ]
}

from · query · 옵션 정보

스키마
스키마
{
  "type": "string",
  "format": "date-time"
}

to · query · 옵션 정보

스키마
스키마
{
  "type": "string",
  "format": "date-time"
}

응답하기

200 관련 기사

200 응답 · application/json

ConsoleJob · Pagination

200 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "pagination",
    "summary"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConsoleJob"
      }
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    },
    "summary": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "required": [
        "completed",
        "credits",
        "failed",
        "total"
      ],
      "properties": {
        "completed": {
          "type": "integer",
          "minimum": 0
        },
        "credits": {
          "type": "number",
          "minimum": 0
        },
        "failed": {
          "type": "integer",
          "minimum": 0
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "updating": {
          "type": "boolean"
        }
      }
    }
  }
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/jobs/{jobId}

하나의 데이터 API 일자리 읽기

job.status를 읽으면 진행 상황을 확인하고 처리가 실패한 경우 job.error를 확인하십시오. JSON는 기본적으로; Accept를 사용하십시오: 읽기 쉬운 원본을 위한 text/plain. X-Respond-With는 여기에 무시됩니다. Retry-After를 따라 다시 검사하기 전에 제공.

인증: cookieSession 또는 dataApiKey

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

Accept · header · 옵션 정보

application/json는 원래 구조화 된 응답을 반환합니다. text/plain는 일반 텍스트로 동일한 필드를 반환합니다. 표준 미디어 범위와 q 무게가 지원됩니다. Accept 또는 JSON에 글로벌 와일드 카드 디폴트가 누락되었습니다. X-Respond-With는 제출 및 작업 통계 엔드 포인트에 무시됩니다. 오류가 발생했습니다. JSON. 응답 유형 모두는 UTF-8를 이용합니다; 명시된 charset=utf-8 모수는 지원됩니다.

스키마
스키마
{
  "type": "string"
}

jobId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^job_[A-Za-z0-9_-]+$"
}

응답하기

200 작업 세부 사항

200 응답 · application/json

ConsoleJob

200 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "job"
  ],
  "properties": {
    "job": {
      "$ref": "#/components/schemas/ConsoleJob"
    }
  }
}
200 응답 · text/plain
200 응답
{
  "type": "string"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

406 application/json 또는 text/plain는 수락가능합니다; 응답은 JSON입니다

406 응답 · application/json

QueryRepresentationError

406 응답
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}
GET/jobs/{jobId}/results

완료된 async 결과를 다운로드

기본적으로, 접근을 정정하고 간결한 개인에 리디렉션 R2 URL; 클라이언트는 본래를 받습니다 JSON 직접에서 R2. Accept: text/plain는 독립적으로 HTTP 200를 반환하고 원본 결과 필드를 indented 일반 텍스트로 반환합니다. X-Respond-With: Markdown은 Markdown 콘텐츠를 선택합니다: application/json는 원본 메타데이터와 함께 콘텐츠에 저장하고, 결과를 대체합니다; text/plain는 Markdown에 따라 메타데이터를 반환합니다. Accept 또는 JSON에 글로벌 와일드카드 디폴트를 미스. Formatting는 다른 쿼리를 제출하지 않거나 쿼리 크레딧을 담당합니다. 저장된 결과는 완료된 후에 24 시간 만료됩니다. 오류가 발생했습니다. JSON.

인증: cookieSession 또는 dataApiKey

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

X-Respond-With · header · 옵션 정보

결과를 Markdown로 반환하기 위해 Markdown을 설정합니다. Omit는 원래 결과를 갖게 됩니다. Accept는 독립적으로 JSON 또는 일반 텍스트를 선택합니다. 실시간 쿼리 및 완료 작업 결과가이 헤더를 지원 읽습니다. 그것은 작업 제출, 상태, 계정 API, 콜백, Bulk 파일, 바이너리 다운로드, 또는 MCP 프로토콜 응답을 변경하지 않습니다.

스키마
스키마
{
  "type": "string",
  "enum": [
    "markdown"
  ]
}

Accept · header · 옵션 정보

application/json 또는 text/plain를 X-Respond-With의 독립적으로 선택하십시오. X-Respond-With 없이, text/plain는 indentation를 가진 본래 분야를 돌려보냅니다; JSON는 원래 응답 필드를 유지 (완전한-result는 저장에 리디렉션을 읽습니다). Markdown으로, JSON는 콘텐츠와 메타데이터와 일반 텍스트를 반환합니다 메타데이터는 Markdown에 의해 따랐습니다. 표준 미디어 범위와 q 무게가 지원됩니다. Accept 또는 JSON에 글로벌 와일드 카드 디폴트가 누락되었습니다. 응답 유형 모두는 UTF-8를 이용합니다; 명시된 charset=utf-8 모수는 지원됩니다.

스키마
스키마
{
  "type": "string"
}

jobId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^job_[A-Za-z0-9_-]+$"
}

응답하기

200 일반 텍스트 원본 필드 또는 Markdown는 직접 반환; 원래 JSON R2에서 기본 리디렉션을 따르는 후

200 응답 · application/json

MarkdownQueryResult

200 응답
{
  "anyOf": [
    {
      "$ref": "#/components/schemas/MarkdownQueryResult"
    },
    {
      "type": "object",
      "additionalProperties": true
    }
  ]
}
200 응답 · text/plain
200 응답
{
  "type": "string"
}

302 원래로 돌아가기 JSON 에 private R2 저장 때 JSON 선택 없음 X-Respond-With

공급 능력: Location

400 지원되지 않는 X-Respond-With 가치; 응답은 JSON입니다

400 응답 · application/json

QueryRepresentationError

400 응답
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

406 application/json 또는 text/plain는 수락가능합니다; 응답은 JSON입니다

406 응답 · application/json

QueryRepresentationError

406 응답
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 결과가 만료됨

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 작업이 실패했습니다. 저장된 실패 원인이 있으면 응답의 detail 필드에 포함됩니다.

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}

Bulk 처리 API

Bulk 엔드포인트에는 매개변수, 요청 예제 및 응답 스키마와 함께 전용 참조가 있습니다. Bulk processing API 열기

팟캐스트

POST/playground/run

현재 작업 공간으로 놀이터 쿼리를 실행

인증: cookieSession + csrfToken

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

요청 몸 · *필수

스키마 · application/json
스키마
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "source",
    "mode",
    "query"
  ],
  "properties": {
    "source": {
      "type": "string"
    },
    "mode": {
      "type": "string",
      "enum": [
        "realtime",
        "async",
        "batch"
      ]
    },
    "query": {
      "description": "Source request body. In batch mode, also accepts an object containing only queries, an array of 1 to 20 request bodies. Every entry must match the selected source and its input schema. Search and Suggestions require query; Channel requires handle; Metadata, Transcript, Captions, Trainability and Download require an 11-character video_id matching [A-Za-z0-9_-]. Download batch entries must supply params.storage for customer storage; console browser delivery is not supported in this envelope. Account batch and pending-job limits still apply.",
      "type": "object",
      "additionalProperties": true
    }
  }
}

응답하기

200 업스트림 데이터 API 응답은 놀이터에 캡처

200 응답 · application/json
200 응답
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "body",
    "endpoint",
    "mode",
    "status"
  ],
  "properties": {
    "body": {},
    "endpoint": {
      "type": "string",
      "enum": [
        "/v1/queries",
        "/v1/queries/batch",
        "/v1/queries/realtime"
      ]
    },
    "mode": {
      "type": "string",
      "enum": [
        "realtime",
        "async",
        "batch"
      ]
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    }
  }
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

422 자주 묻는 질문

422 응답 · application/problem+json

Problem

422 응답
{
  "$ref": "#/components/schemas/Problem"
}
GET/playground/jobs/{jobId}/download

현재 브라우저에서 완료된 놀이터 artifact 다운로드

인증: cookieSession

서버: https://api.flashdata.dev/v2

서버: http://localhost:5000/v2

제품 설명

jobId · path · *필수

스키마
스키마
{
  "type": "string",
  "pattern": "^job_[A-Za-z0-9_-]+$"
}

응답하기

200 임시 브라우저 다운로드 artifact

공급 능력: Content-Disposition, Content-Length

200 응답 · application/octet-stream
200 응답
{
  "type": "string",
  "format": "binary"
}

401 인증 필요 또는 잘못된

401 응답 · application/problem+json

Problem

401 응답
{
  "$ref": "#/components/schemas/Problem"
}

404 검색 결과를 찾을 수 없음 한국어 사전에

404 응답 · application/problem+json

Problem

404 응답
{
  "$ref": "#/components/schemas/Problem"
}

409 자원 상태 또는 idempotency 분쟁

409 응답 · application/problem+json

Problem

409 응답
{
  "$ref": "#/components/schemas/Problem"
}

410 일시적인 artifact가 만료되었습니다

410 응답 · application/problem+json

Problem

410 응답
{
  "$ref": "#/components/schemas/Problem"
}

503 필수 조건 또는 카탈로그는 일시적으로 사용할 수 없습니다

503 응답 · application/problem+json

Problem

503 응답
{
  "$ref": "#/components/schemas/Problem"
}

Schema 정의

APIKeyIdentity
APIKeyIdentity
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apiKeyId": {
      "type": "string"
    },
    "accountId": {
      "type": "string"
    },
    "accountType": {
      "type": "string",
      "enum": [
        "owned",
        "temporary"
      ]
    },
    "ownership": {
      "type": "string",
      "enum": [
        "owned",
        "unowned"
      ]
    },
    "access": {
      "type": "string",
      "enum": [
        "ready",
        "blocked"
      ]
    },
    "installed": {
      "type": "boolean"
    },
    "recurringAllowed": {
      "type": "boolean"
    },
    "connectionId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "expiresAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ]
    },
    "verifiedAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "apiKeyId",
    "accountId",
    "accountType",
    "ownership",
    "access",
    "installed",
    "recurringAllowed",
    "connectionId",
    "scopes",
    "expiresAt",
    "verifiedAt"
  ],
  "description": "Authoritative current-record ownership and readiness. Public IDs only. recurringAllowed requires a verified active owner and, for agent-issued keys, server-confirmed installation. It is a point-in-time check, not an authorization token or permission to reuse cached data after revocation."
}
Account
Account
{
  "type": "object",
  "description": "Deleted accounts are only returned through authorized Admin projections; their identity fields are redacted.",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "email",
    "status",
    "emailVerified",
    "legalAcceptanceRequired",
    "role",
    "timezone",
    "createdAt",
    "updatedAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^acct_"
    },
    "name": {
      "type": "string"
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "format": "email"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending_verification",
        "active",
        "suspended",
        "deleting",
        "deleted"
      ]
    },
    "emailVerified": {
      "type": "boolean"
    },
    "legalAcceptanceRequired": {
      "type": "boolean"
    },
    "role": {
      "type": "string",
      "enum": [
        "user",
        "admin"
      ]
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
AccountDeletionRequest
AccountDeletionRequest
{
  "type": "object",
  "description": "User-safe deletion summary. Durable processor cursor and per-step metadata are internal operational state and are intentionally omitted.",
  "additionalProperties": false,
  "required": [
    "id",
    "status",
    "requestedAt",
    "scheduledFor",
    "cancellable",
    "billingCancellationStatus",
    "activeJobsAtRequest",
    "retryable"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^del_"
    },
    "status": {
      "type": "string",
      "enum": [
        "scheduled",
        "cancelled",
        "processing",
        "completed",
        "failed"
      ]
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time"
    },
    "scheduledFor": {
      "type": "string",
      "format": "date-time"
    },
    "cancellable": {
      "type": "boolean"
    },
    "cancelledAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "processingStartedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "failureCode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 80
    },
    "billingCancellationStatus": {
      "type": "string",
      "enum": [
        "not_required",
        "pending",
        "completed",
        "failed"
      ]
    },
    "activeJobsAtRequest": {
      "type": "integer",
      "minimum": 0
    },
    "retryable": {
      "type": "boolean",
      "description": "True only when an Admin-audited processor retry is possible; it does not grant the user mutation access."
    }
  }
}
AgentApproval
AgentApproval
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "allowAccountBalance": {
      "const": true
    }
  },
  "required": [
    "scopes",
    "allowAccountBalance"
  ]
}
AgentBrowserClaim
AgentBrowserClaim
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "claimId": {
      "type": "string"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "connection",
    "claimId",
    "expiresAt"
  ]
}
AgentCapabilities
AgentCapabilities
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "protocolVersion": {
      "const": 2
    },
    "available": {
      "type": "boolean"
    },
    "flow": {
      "const": "temporary_account_api_key"
    },
    "dataOrigin": {
      "type": "string"
    },
    "queryPath": {
      "const": "/v1/queries/realtime"
    },
    "credentialType": {
      "const": "api_key"
    },
    "permissions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AgentPermission"
      }
    },
    "owner": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "scopes"
      ],
      "properties": {
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "trial": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "credits": {
          "type": "number"
        },
        "lifetimeHours": {
          "type": "integer",
          "minimum": 0
        },
        "requestsPerSecond": {
          "type": "integer",
          "minimum": 0
        },
        "maxBatchSize": {
          "type": "integer",
          "minimum": 0
        },
        "requestCounts": {}
      },
      "required": [
        "credits",
        "lifetimeHours",
        "requestsPerSecond",
        "maxBatchSize",
        "requestCounts"
      ]
    },
    "recurringRequires": {
      "const": "owned_key_installed"
    },
    "replayProtection": {
      "const": "client_local_only"
    }
  },
  "required": [
    "protocolVersion",
    "available"
  ]
}
AgentClaim
AgentClaim
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "claimId": {
      "type": "string"
    },
    "claimPath": {
      "type": "string"
    },
    "confirmationCode": {
      "type": "string",
      "pattern": "^\\d{8}$"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "pollAfterSeconds": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "claimId",
    "claimPath",
    "confirmationCode",
    "expiresAt",
    "pollAfterSeconds"
  ]
}
AgentClaimView
AgentClaimView
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "connection"
  ],
  "properties": {
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "handoff": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "status"
      ],
      "properties": {
        "status": {
          "type": "string"
        }
      }
    }
  }
}
AgentConnection
AgentConnection
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "audience": {
      "type": "string",
      "enum": [
        "coding",
        "personal",
        "unspecified"
      ]
    },
    "ownership": {
      "type": "string",
      "enum": [
        "owned",
        "unowned"
      ]
    },
    "lifecycle": {
      "type": "string",
      "enum": [
        "valid",
        "revoked",
        "expired"
      ]
    },
    "access": {
      "type": "string",
      "enum": [
        "ready",
        "fenced",
        "blocked"
      ]
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Actual scopes on the current API key. May be empty on an unowned claim-only connection; every data-source request is then forbidden."
    },
    "requestedScopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Original owner-access request. Claim approval can only reduce this set. Legacy connections retain their original scopes."
    },
    "trialScopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Saved subset eligible for the temporary key. Never expanded by catalog changes."
    },
    "permissions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AgentPermission"
      }
    },
    "generation": {
      "type": "integer",
      "minimum": 0
    },
    "installed": {
      "type": "boolean"
    },
    "trialExpiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "fundingMode": {
      "type": "string",
      "enum": [
        "trial",
        "account_balance"
      ]
    },
    "trialCredits": {
      "type": "number"
    },
    "trialRequestCounts": {}
  },
  "required": [
    "id",
    "name",
    "audience",
    "ownership",
    "lifecycle",
    "access",
    "scopes",
    "generation",
    "installed",
    "trialExpiresAt",
    "fundingMode",
    "trialCredits",
    "trialRequestCounts"
  ]
}
AgentConnectionResponse
AgentConnectionResponse
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    }
  },
  "required": [
    "connection"
  ]
}
AgentHandoff
AgentHandoff
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "delivered",
        "confirmed"
      ]
    },
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "credentials": {
      "$ref": "#/components/schemas/AgentCredentials"
    },
    "generation": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "status"
  ]
}
AgentCredentials
AgentCredentials
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connectionId": {
      "type": "string"
    },
    "apiKey": {
      "type": "string"
    },
    "setupCredential": {
      "type": "string"
    },
    "handoffProof": {
      "type": "string"
    },
    "generation": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "connectionId",
    "apiKey",
    "generation"
  ],
  "description": "Sensitive ordinary API-key credentials. Never log or put in browser URLs. Proofs are returned on temporary registration; handoff returns the owned candidate key."
}
AgentOnboardingStatus
AgentOnboardingStatus
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "awaiting_claim",
        "claim_processing",
        "handoff_ready",
        "installed",
        "handoff_expired",
        "expired",
        "revoked",
        "blocked"
      ]
    },
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "nextAction": {
      "type": "string"
    },
    "pollAfterSeconds": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "status"
  ]
}
AgentPermission
AgentPermission
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "source",
    "name",
    "product",
    "trialEligible",
    "ownerAllowed",
    "requiresStorageDestination"
  ],
  "properties": {
    "source": {
      "type": "string",
      "pattern": "^[a-z_]{1,80}$"
    },
    "name": {
      "type": "string"
    },
    "product": {
      "type": "string"
    },
    "trialEligible": {
      "type": "boolean"
    },
    "ownerAllowed": {
      "type": "boolean"
    },
    "requiresStorageDestination": {
      "type": "boolean"
    }
  },
  "description": "Catalog-derived agent permissions. Trial eligibility is an explicit opt-in independent of owner approval. Storage and variable-price sources require owner access."
}
AgentRegistration
AgentRegistration
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "credentials": {
      "$ref": "#/components/schemas/AgentCredentials"
    },
    "dataOrigin": {
      "type": "string"
    },
    "deniedScopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "limits": {
      "type": "object",
      "additionalProperties": true
    },
    "nextAction": {
      "type": "string",
      "enum": [
        "query_or_claim",
        "claim"
      ],
      "description": "Claim before the first data request when no requested source is trial eligible."
    }
  },
  "required": [
    "connection",
    "credentials",
    "dataOrigin",
    "deniedScopes",
    "limits"
  ]
}
AgentRegistrationRequest
AgentRegistrationRequest
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "audience": {
      "type": "string",
      "enum": [
        "coding",
        "personal"
      ]
    },
    "scopes": {
      "type": "array",
      "minItems": 1,
      "maxItems": 30,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "pattern": "^[a-z_]{1,80}$"
      }
    },
    "client": {
      "type": "string",
      "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
    },
    "transport": {
      "type": "string",
      "enum": [
        "api",
        "cli",
        "mcp"
      ]
    }
  },
  "required": [
    "name",
    "scopes"
  ]
}
ApiAccess
ApiAccess
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "sources",
    "result_origin"
  ],
  "properties": {
    "sources": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "$ref": "#/components/schemas/ApiAccessSource"
      }
    },
    "result_origin": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "Configured signed-result storage origin, without credentials, path, query or fragment. Not an access token or a media URL."
    }
  }
}
ApiAccessBalance
ApiAccessBalance
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "scope",
    "unit",
    "balanceCredits",
    "availableCredits",
    "updatedAt",
    "note"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "const": "account"
    },
    "unit": {
      "type": "string",
      "const": "Credits"
    },
    "balanceCredits": {
      "type": "number",
      "description": "Signed live balance; in-flight reservations may already be reflected."
    },
    "availableCredits": {
      "type": "number",
      "minimum": 0,
      "description": "max(balanceCredits, 0)."
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "note": {
      "type": "string"
    }
  }
}
ApiAccessLimits
ApiAccessLimits
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "scope",
    "plan",
    "limits",
    "current",
    "note"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "const": "account"
    },
    "plan": {
      "$ref": "#/components/schemas/ApiAccessPlan"
    },
    "limits": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "concurrency": {
          "type": "integer",
          "minimum": 0
        },
        "batchSize": {
          "type": "integer",
          "minimum": 0
        },
        "pendingJobs": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "current": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "pendingJobs"
      ],
      "properties": {
        "pendingJobs": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "note": {
      "type": "string"
    }
  }
}
ApiAccessPlan
ApiAccessPlan
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "billingMode": {
      "type": "string"
    },
    "status": {
      "type": "string"
    }
  }
}
ApiAccessPricing
ApiAccessPricing
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "unit",
    "plan",
    "requestCount",
    "prices",
    "note"
  ],
  "properties": {
    "unit": {
      "type": "string",
      "const": "Credits"
    },
    "plan": {
      "$ref": "#/components/schemas/ApiAccessPlan"
    },
    "requestCount": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "prices": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "source",
          "available",
          "estimatedCredits"
        ],
        "properties": {
          "source": {
            "$ref": "#/components/schemas/ApiAccessSource"
          },
          "available": {
            "type": "boolean"
          },
          "creditsPerRequest": {
            "type": [
              "number",
              "null"
            ],
            "minimum": 0
          },
          "estimatedCredits": {
            "type": [
              "number",
              "null"
            ],
            "minimum": 0,
            "description": "Null for downloads or missing pricing."
          },
          "billingUnit": {
            "type": "string",
            "const": "TB"
          },
          "bytesPerUnit": {
            "type": "integer",
            "const": 1000000000000
          },
          "creditsPerTb": {
            "type": [
              "number",
              "null"
            ],
            "minimum": 0
          },
          "note": {
            "type": "string"
          }
        }
      }
    },
    "note": {
      "type": "string"
    }
  }
}
ApiAccessSource
ApiAccessSource
{
  "type": "string",
  "enum": [
    "google_search",
    "google_images",
    "google_news",
    "google_shopping",
    "google_videos",
    "google_places",
    "youtube_search",
    "youtube_search_extended",
    "youtube_metadata",
    "youtube_transcript",
    "youtube_captions",
    "youtube_trainability",
    "youtube_channel",
    "youtube_suggestions",
    "youtube_download"
  ]
}
ApiKey
ApiKey
{
  "type": "object",
  "description": "API key details. A key remains active until scheduledRevocationAt when revocation is scheduled.",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "prefix",
    "last4",
    "scopes",
    "status",
    "createdAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^key_"
    },
    "name": {
      "type": "string"
    },
    "prefix": {
      "type": "string"
    },
    "last4": {
      "type": "string",
      "minLength": 4,
      "maxLength": 4
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "revoked",
        "expired"
      ]
    },
    "lastUsedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "expiresAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "scheduledRevocationAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Planned revocation time for an overlapping retiring key; null for a primary or immediately revoked key."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
ApiKeyCreated
ApiKeyCreated
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "apiKey",
    "secret"
  ],
  "properties": {
    "apiKey": {
      "$ref": "#/components/schemas/ApiKey"
    },
    "secret": {
      "type": "string",
      "readOnly": true,
      "pattern": "^fd_(?:(?:test|live)_)?[A-Za-z0-9_-]{43}$",
      "description": "Plaintext secret returned only by this create/rotate transaction. Newly issued secrets use the `fd_` prefix. Previously issued `fd_test_` and `fd_live_` secrets still authenticate. An authenticated replay with the same Idempotency-Key and request body may receive the same KMS-encrypted response for five minutes; it is not recoverable afterward.",
      "x-secret-reveal": "once"
    }
  }
}
ApiKeyUsage
ApiKeyUsage
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "scope",
    "unit",
    "from",
    "to",
    "observedAt",
    "totals",
    "bySource",
    "updating",
    "note"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "const": "account_authorized_sources"
    },
    "unit": {
      "type": "string",
      "const": "Credits"
    },
    "from": {
      "type": "string",
      "format": "date-time"
    },
    "to": {
      "type": "string",
      "format": "date-time"
    },
    "observedAt": {
      "type": "string",
      "format": "date-time"
    },
    "totals": {
      "$ref": "#/components/schemas/UsageCounts"
    },
    "bySource": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "source",
          "requests",
          "completed",
          "failed",
          "credits"
        ],
        "properties": {
          "source": {
            "type": "string"
          },
          "requests": {
            "type": "integer",
            "minimum": 0
          },
          "completed": {
            "type": "integer",
            "minimum": 0
          },
          "failed": {
            "type": "integer",
            "minimum": 0
          },
          "credits": {
            "type": "number",
            "minimum": 0
          }
        }
      }
    },
    "updating": {
      "type": "boolean"
    },
    "note": {
      "type": "string"
    }
  }
}
BillingPaymentPage
BillingPaymentPage
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "pagination"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BillingPayment"
      }
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    }
  }
}
BillingPayment
BillingPayment
{
  "description": "Account-scoped top-up projection. Refund state is updated only from verified provider events; this API does not initiate refunds.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "purchaseType",
    "status",
    "currency",
    "amount",
    "refundedAmount",
    "credits",
    "reversedCredits",
    "createdAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^pay_"
    },
    "purchaseType": {
      "type": "string",
      "const": "top_up"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "paid",
        "partially_refunded",
        "refunded",
        "failed"
      ]
    },
    "currency": {
      "type": "string",
      "const": "USD"
    },
    "amount": {
      "type": "integer",
      "minimum": 0,
      "description": "USD cents"
    },
    "refundedAmount": {
      "type": "integer",
      "minimum": 0,
      "description": "USD cents"
    },
    "credits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001
    },
    "hostedInvoiceUrl": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "Stripe-hosted HTTPS invoice URL, when Stripe created an invoice for this top-up."
    },
    "invoiceNumber": {
      "type": [
        "string",
        "null"
      ],
      "description": "Stripe invoice number, when available."
    },
    "reversedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "Cumulative credits removed by append-only payment_reversal entries; never exceeds credits."
    },
    "paidAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "refundedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
BulkJobCreated
BulkJobCreated
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "job",
    "upload"
  ],
  "properties": {
    "job": {
      "$ref": "#/components/schemas/BulkJob"
    },
    "upload": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "href",
        "method",
        "expiresAt",
        "contentType"
      ],
      "properties": {
        "href": {
          "type": "string",
          "format": "uri"
        },
        "method": {
          "type": "string",
          "const": "PUT"
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time"
        },
        "contentType": {
          "type": "string",
          "const": "text/plain; charset=utf-8"
        }
      }
    }
  }
}
BulkJob
BulkJob
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "source",
    "status",
    "input",
    "counts",
    "delivery",
    "pauseReason",
    "error",
    "createdAt",
    "startedAt",
    "completedAt",
    "expiresAt",
    "links"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^bulk_[A-Za-z0-9_-]{8,}$"
    },
    "source": {
      "type": "string",
      "enum": [
        "youtube_metadata",
        "youtube_transcript",
        "youtube_captions",
        "youtube_trainability",
        "youtube_download"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "awaiting_upload",
        "running",
        "paused",
        "finalizing",
        "completed",
        "failed",
        "cancelled"
      ]
    },
    "input": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "bytes",
        "complete",
        "scannedBytes",
        "scannedLines"
      ],
      "properties": {
        "bytes": {
          "type": "integer",
          "minimum": 0
        },
        "complete": {
          "type": "boolean"
        },
        "scannedBytes": {
          "type": "integer",
          "minimum": 0
        },
        "scannedLines": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "counts": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "accepted",
        "completed",
        "failed",
        "invalid",
        "results"
      ],
      "properties": {
        "accepted": {
          "type": "integer",
          "minimum": 0
        },
        "completed": {
          "type": "integer",
          "minimum": 0
        },
        "failed": {
          "type": "integer",
          "minimum": 0
        },
        "invalid": {
          "type": "integer",
          "minimum": 0
        },
        "results": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "pauseReason": {
      "type": [
        "string",
        "null"
      ]
    },
    "delivery": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "customerStorage",
        "storageType",
        "uploadedParts",
        "retryCount"
      ],
      "properties": {
        "customerStorage": {
          "type": "boolean"
        },
        "storageType": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "s3",
            "s3_compatible",
            "oss",
            "gcs",
            "azure",
            "cos",
            "bos",
            "tos",
            null
          ]
        },
        "uploadedParts": {
          "type": "integer",
          "minimum": 0
        },
        "retryCount": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "error": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "code",
            "detail"
          ],
          "properties": {
            "code": {
              "type": "string"
            },
            "detail": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        }
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "startedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "expiresAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JobLink"
      }
    }
  }
}
BulkJobPage
BulkJobPage
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "pagination"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BulkJob"
      }
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    }
  }
}
BulkJobResponse
BulkJobResponse
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "job"
  ],
  "properties": {
    "job": {
      "$ref": "#/components/schemas/BulkJob"
    }
  }
}
ConsoleJob
ConsoleJob
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "createdAt",
    "credits",
    "durationMs",
    "error",
    "id",
    "params",
    "progress",
    "result",
    "source",
    "status",
    "updatedAt",
    "videoId"
  ],
  "properties": {
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "credits": {
      "type": "number",
      "multipleOf": 0.001
    },
    "durationMs": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "type": "string"
    },
    "params": {
      "type": "object",
      "additionalProperties": true
    },
    "progress": {
      "type": "integer",
      "minimum": 0
    },
    "result": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": true
    },
    "source": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "completed",
        "failed",
        "pending",
        "processing"
      ]
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "videoId": {
      "type": [
        "string",
        "null"
      ]
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JobLink"
      }
    }
  }
}
ConsoleOverview
ConsoleOverview
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "account",
    "onboarding",
    "subscription",
    "balance",
    "publicStatus",
    "degradedSections",
    "generatedAt"
  ],
  "properties": {
    "account": {
      "$ref": "#/components/schemas/Account"
    },
    "onboarding": {
      "$ref": "#/components/schemas/OnboardingProgress"
    },
    "subscription": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/Subscription"
        },
        {
          "type": "null"
        }
      ]
    },
    "balance": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/CreditBalance"
        },
        {
          "type": "null"
        }
      ]
    },
    "publicStatus": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/PublicStatus"
        },
        {
          "type": "null"
        }
      ]
    },
    "degradedSections": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "subscription",
          "balance",
          "public_status"
        ]
      },
      "description": "A listed section uses its unavailable representation; null and empty values must not be interpreted as zero or healthy."
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
CreateApiKeyRequest
CreateApiKeyRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name",
    "scopes"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "scopes": {
      "type": "array",
      "minItems": 1,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "google_search",
          "google_images",
          "google_news",
          "google_shopping",
          "google_videos",
          "google_places",
          "youtube_search",
          "youtube_search_extended",
          "youtube_metadata",
          "youtube_transcript",
          "youtube_captions",
          "youtube_trainability",
          "youtube_channel",
          "youtube_suggestions",
          "youtube_download"
        ]
      }
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
CreateBulkJobRequest
CreateBulkJobRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "source"
  ],
  "properties": {
    "source": {
      "type": "string",
      "enum": [
        "youtube_metadata",
        "youtube_transcript",
        "youtube_captions",
        "youtube_trainability",
        "youtube_download"
      ]
    },
    "options": {
      "type": "object",
      "additionalProperties": true,
      "description": "Reused for every ID. Metadata accepts include_formats and include_chapters. Transcript and captions accept language (one code or an array of 1–10 distinct codes) and auto (applies to all requested languages). Omit language to prefer en-orig, fall back to en, and return one track. With auto=true, each requested code tries its -orig track first, then the plain code. Explicit -orig codes and auto=false stay exact. languageCode identifies the selected track; requestedLanguageCode is included when it differs from the requested code. A language array returns tracks and per-language errors for each video with at least one retrieved track. If no track is retrieved, the video job fails and its reserved credits are refunded. Bulk exports use one JSONL record per video. Trainability accepts no source options. These four data sources optionally accept result_storage. Supported storage_type values are s3, s3_compatible, oss, gcs, azure, cos, bos, and tos. storage_url is the bucket name (Azure container name); object_prefix is optional. S3, S3-compatible, OSS, COS, BOS, and TOS use access_key and secret_key. S3-compatible and OSS also require a public HTTPS endpoint_url. COS, BOS, and TOS require region and use fixed provider endpoints. COS bucket names include the APPID. BOS S3-compatible HTTPS delivery supports bj, su, and hkg. GCS requires service_account with project_id, client_email, and private_key. Azure requires account_name and a container SAS sas_token with write permission. Default object_prefix is YYYYMMDD, frozen to the UTC bulk creation date. Files are written to <prefix>/<source>/<bulkId>/results/part-NNNNNNNN.jsonl.gz; manifest.json in the same bulk directory is written last. Each JSONL row includes its input index and completed, failed, or invalid status. Internal R2 results remain available through the result links for 24 hours. Download accepts the normal YouTube download parameters, requires customer storage, and does not permit browser_delivery. Download storage supports the same eight provider types and credential shapes listed above under the storage field. Download storage may include object_prefix; YYYYMMDD tokens resolve to the UTC upload date, while literal prefixes are unchanged."
    },
    "callback_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "Optional public HTTPS endpoint notified once after manifest publication."
    }
  }
}
CreateDeliveryWebhookRequest
CreateDeliveryWebhookRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name",
    "url"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    }
  }
}
CreditBalance
CreditBalance
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "balanceCredits",
    "reservedCredits",
    "availableCredits",
    "lifetimeGrantedCredits",
    "lifetimeUsedCredits",
    "lifetimeRefundedCredits",
    "lifetimePaymentReversedCredits",
    "updatedAt"
  ],
  "properties": {
    "balanceCredits": {
      "type": "number",
      "multipleOf": 0.001,
      "description": "Signed settled balance after grants, usage, refunds and provider reversals."
    },
    "reservedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001
    },
    "availableCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "max(balanceCredits, 0)."
    },
    "lifetimeGrantedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001
    },
    "lifetimeUsedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001
    },
    "lifetimeRefundedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "Credits returned to the account after failed usage."
    },
    "lifetimePaymentReversedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "Absolute Credits removed after verified provider refunds or chargebacks."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
CreditEntryType
CreditEntryType
{
  "type": "string",
  "enum": [
    "subscription_grant",
    "topup_grant",
    "payment_reversal",
    "admin_adjustment",
    "trial_grant"
  ]
}
CreditPolicy
CreditPolicy
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "unit",
    "failedRequestsCharged",
    "subscriptionGrantTiming",
    "refundHandling"
  ],
  "properties": {
    "unit": {
      "type": "string",
      "const": "credit"
    },
    "failedRequestsCharged": {
      "type": "boolean",
      "const": false
    },
    "subscriptionGrantTiming": {
      "type": "string",
      "const": "invoice_paid"
    },
    "refundHandling": {
      "type": "string",
      "const": "append_only_reversal",
      "description": "Failed requests are refunded; verified provider refunds remove the proportional Credits through immutable transactions."
    }
  }
}
CreditTransaction
CreditTransaction
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "type",
    "deltaCredits",
    "balanceAfterCredits",
    "createdAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^ctx_"
    },
    "type": {
      "$ref": "#/components/schemas/CreditEntryType"
    },
    "deltaCredits": {
      "type": "number",
      "multipleOf": 0.001
    },
    "balanceAfterCredits": {
      "type": [
        "number",
        "null"
      ],
      "multipleOf": 0.001,
      "description": "Signed settled balance after this immutable transaction, when recorded."
    },
    "description": {
      "type": "string"
    },
    "requestId": {
      "type": [
        "string",
        "null"
      ]
    },
    "jobId": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
DataSource
DataSource
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "category",
    "product",
    "modes",
    "inputSchema",
    "estimatedCredits",
    "requiresStorageDestination"
  ],
  "properties": {
    "id": {
      "type": "string",
      "enum": [
        "google_search",
        "google_images",
        "google_news",
        "google_shopping",
        "google_videos",
        "google_places",
        "youtube_search",
        "youtube_search_extended",
        "youtube_metadata",
        "youtube_transcript",
        "youtube_captions",
        "youtube_trainability",
        "youtube_channel",
        "youtube_suggestions",
        "youtube_download"
      ]
    },
    "name": {
      "type": "string"
    },
    "category": {
      "type": "string",
      "enum": [
        "google",
        "youtube"
      ]
    },
    "product": {
      "type": "string",
      "enum": [
        "google_search",
        "youtube_data",
        "youtube_download"
      ]
    },
    "modes": {
      "type": "array",
      "minItems": 1,
      "uniqueItems": true,
      "description": "Only modes backed by a real adapter or consumer in the current release",
      "items": {
        "type": "string",
        "enum": [
          "realtime",
          "async",
          "batch"
        ]
      }
    },
    "inputSchema": {
      "type": "object",
      "additionalProperties": true,
      "description": "JSON Schema used by the Playground and generated clients"
    },
    "estimatedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001
    },
    "requiresStorageDestination": {
      "type": "boolean",
      "description": "Whether query submission must include per-request storage configuration."
    }
  }
}
DeliveryWebhook
DeliveryWebhook
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "createdAt",
    "id",
    "lastTestStatus",
    "lastTestedAt",
    "name",
    "status",
    "updatedAt",
    "url"
  ],
  "properties": {
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "id": {
      "type": "string",
      "pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
    },
    "lastTestStatus": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "lastTestedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "disabled"
      ]
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "url": {
      "type": "string",
      "format": "uri"
    }
  }
}
Health
Health
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "status",
    "service",
    "version",
    "time"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "healthy",
        "degraded"
      ]
    },
    "service": {
      "type": "string"
    },
    "version": {
      "type": "string"
    },
    "time": {
      "type": "string",
      "format": "date-time"
    }
  }
}
HostedSession
HostedSession
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "url",
    "expiresAt"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Provider-hosted HTTPS URL on a Stripe-controlled *.stripe.com host. Web clients must validate the origin and redirect from a server-only boundary."
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
Invoice
Invoice
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "number",
    "status",
    "currency",
    "total",
    "amountPaid",
    "refundedAmount",
    "billingReason",
    "createdAt",
    "periodStart",
    "periodEnd"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^inv_"
    },
    "number": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "open",
        "paid",
        "void",
        "uncollectible"
      ]
    },
    "currency": {
      "type": "string",
      "const": "USD"
    },
    "total": {
      "type": "integer",
      "description": "USD cents"
    },
    "amountPaid": {
      "type": "integer",
      "description": "USD cents"
    },
    "refundedAmount": {
      "type": "integer",
      "minimum": 0,
      "description": "Cumulative USD cents observed from verified provider events."
    },
    "billingReason": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "subscription_create",
        "subscription_cycle",
        "subscription_update",
        null
      ]
    },
    "hostedInvoiceUrl": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "Stripe-hosted HTTPS invoice URL. Production Web clients accept only Stripe-controlled *.stripe.com origins."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "paidAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "periodStart": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "periodEnd": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}
LegalAcceptanceRequest
LegalAcceptanceRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "acceptedTerms",
    "termsVersion",
    "privacyVersion"
  ],
  "properties": {
    "acceptedTerms": {
      "type": "boolean",
      "const": true
    },
    "termsVersion": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "privacyVersion": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  }
}
LoginRequest
LoginRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email",
    "password"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 320
    },
    "password": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    },
    "rememberMe": {
      "type": "boolean",
      "default": false,
      "description": "Ignored for email_verification, legal_acceptance and deletion_recovery Sessions, which always use a short fixed expiry."
    }
  }
}
LoginResponse
LoginResponse
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "account",
    "csrfToken",
    "sessionMode"
  ],
  "properties": {
    "account": {
      "$ref": "#/components/schemas/Account"
    },
    "csrfToken": {
      "type": "string",
      "minLength": 32,
      "readOnly": true
    },
    "sessionMode": {
      "type": "string",
      "enum": [
        "full",
        "email_verification",
        "legal_acceptance",
        "deletion_recovery"
      ]
    }
  }
}
MarkdownQueryResult
MarkdownQueryResult
{
  "type": "object",
  "required": [
    "source",
    "status",
    "content"
  ],
  "additionalProperties": true,
  "description": "Markdown result content. content replaces the results array; other response fields such as id, source, status, usage and timestamps are preserved. No generated summary is added. Source URLs and transcript segment start/end times are retained.",
  "properties": {
    "source": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "content": {
      "type": "string",
      "description": "Deterministic Markdown derived from the retrieved source result."
    },
    "usage": {
      "type": "object",
      "additionalProperties": true
    }
  }
}
OAuthConnection
OAuthConnection
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "clientName",
    "scope",
    "status",
    "createdAt",
    "expiresAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^oag_[A-Za-z0-9_-]{8,}$"
    },
    "clientName": {
      "type": "string"
    },
    "scope": {
      "type": "string",
      "enum": [
        "mcp:research"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "expired",
        "revoked"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
OAuthConsent
OAuthConsent
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "clientName",
    "scope",
    "sources",
    "redirectUri",
    "expiresAt"
  ],
  "properties": {
    "clientName": {
      "type": "string",
      "maxLength": 80
    },
    "scope": {
      "type": "string",
      "enum": [
        "mcp:research"
      ]
    },
    "sources": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "google_search",
          "youtube_search",
          "youtube_metadata",
          "youtube_transcript"
        ]
      }
    },
    "redirectUri": {
      "type": "string",
      "format": "uri"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
OnboardingProgress
OnboardingProgress
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "currentStep",
    "apiKeyStepStatus",
    "firstRequestStatus",
    "version",
    "updatedAt"
  ],
  "properties": {
    "currentStep": {
      "type": "string",
      "enum": [
        "welcome",
        "api_key",
        "first_request",
        "completed"
      ]
    },
    "useCase": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "google_search",
        "youtube_data",
        "download",
        null
      ]
    },
    "apiKeyStepStatus": {
      "type": "string",
      "enum": [
        "pending",
        "created",
        "skipped"
      ]
    },
    "firstRequestStatus": {
      "type": "string",
      "enum": [
        "pending",
        "succeeded",
        "skipped"
      ]
    },
    "firstApiKeyId": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^key_"
    },
    "firstRequestId": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^req_"
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "version": {
      "type": "integer",
      "minimum": 0
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
Page
Page
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "pagination"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {}
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    }
  }
}
Pagination
Pagination
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "hasMore",
    "limit"
  ],
  "properties": {
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    },
    "previousCursor": {
      "type": [
        "string",
        "null"
      ]
    },
    "hasMore": {
      "type": "boolean"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  }
}
Password
Password
{
  "type": "string",
  "minLength": 8,
  "maxLength": 128,
  "writeOnly": true
}
PlanCatalog
PlanCatalog
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "currency",
    "billingAvailability",
    "creditValueUsd"
  ],
  "properties": {
    "trialOffer": {
      "description": "Current one-time trial allowance expressed as alternative PAYG usage amounts. Eligibility and approval are required. The amounts share one balance and are not additive. Null when a reliable estimate is unavailable. This is not an account eligibility decision or a promise of immediate credit issuance.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/PublicTrialOffer"
        },
        {
          "type": "null"
        }
      ]
    },
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Plan"
      }
    },
    "currency": {
      "type": "string",
      "const": "USD"
    },
    "creditValueUsd": {
      "type": "number",
      "exclusiveMinimum": 0,
      "description": "Fixed USD value of one credit, used to preview custom top-ups. The server computes the credited amount."
    },
    "billingAvailability": {
      "type": "string",
      "enum": [
        "available",
        "unconfigured",
        "unavailable"
      ]
    },
    "billingMessage": {
      "type": [
        "string",
        "null"
      ],
      "description": "Stable, non-sensitive explanation suitable for the Pricing and Billing UI."
    }
  }
}
Plan
Plan
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "slug",
    "name",
    "description",
    "includedCredits",
    "limits",
    "prices",
    "features",
    "usagePrices"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^plan_"
    },
    "slug": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "includedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "Credits included in each paid subscription cycle; zero for Pay As You Go."
    },
    "limits": {
      "$ref": "#/components/schemas/PlanLimits"
    },
    "prices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PlanPrice"
      }
    },
    "features": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "usagePrices": {
      "$ref": "#/components/schemas/PlanUsagePrices"
    }
  }
}
PlanLimits
PlanLimits
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "concurrency",
    "maxBatchSize",
    "maxPendingJobs"
  ],
  "properties": {
    "concurrency": {
      "type": "integer",
      "minimum": 1
    },
    "maxBatchSize": {
      "type": "integer",
      "minimum": 1
    },
    "maxPendingJobs": {
      "type": "integer",
      "minimum": 1
    }
  }
}
PlanPrice
PlanPrice
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "currency",
    "unitAmount",
    "credits",
    "type",
    "interval"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^prc_"
    },
    "currency": {
      "type": "string",
      "const": "USD"
    },
    "unitAmount": {
      "type": "integer",
      "minimum": 0,
      "description": "USD cents"
    },
    "credits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "Credits granted by a successful one-time top-up; zero for recurring prices."
    },
    "type": {
      "type": "string",
      "enum": [
        "recurring",
        "one_time"
      ]
    },
    "interval": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "month",
        "year",
        null
      ]
    }
  }
}
PlanUsagePrices
PlanUsagePrices
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "googlePer1kCents",
    "youtubePer1kCents",
    "downloadPerTbCents"
  ],
  "properties": {
    "googlePer1kCents": {
      "type": "integer",
      "minimum": 0,
      "description": "Google request price per 1,000 successful requests, in USD cents."
    },
    "youtubePer1kCents": {
      "type": "integer",
      "minimum": 0,
      "description": "Standard YouTube request price per 1,000 successful requests, in USD cents."
    },
    "downloadPerTbCents": {
      "type": "integer",
      "minimum": 0,
      "description": "Download price per decimal TB (1,000,000,000,000 bytes), in USD cents."
    }
  }
}
Problem
Problem
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri-reference"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string",
      "pattern": "^[a-z0-9_]+$"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string",
      "pattern": "^req_"
    },
    "fieldErrors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FieldError"
      }
    }
  }
}
FieldError
FieldError
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "field",
    "code",
    "message"
  ],
  "properties": {
    "field": {
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}
PublicLegalVersions
PublicLegalVersions
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "availability",
    "termsVersion",
    "privacyVersion"
  ],
  "properties": {
    "availability": {
      "type": "string",
      "enum": [
        "configured",
        "unconfigured"
      ]
    },
    "termsVersion": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "maxLength": 64
    },
    "privacyVersion": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "maxLength": 64
    }
  }
}
PublicStatus
PublicStatus
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "status",
    "updatedAt",
    "components"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "healthy",
        "degraded",
        "outage"
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "components": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PublicStatusComponent"
      }
    }
  }
}
PublicStatusComponent
PublicStatusComponent
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "operational",
        "degraded",
        "outage"
      ]
    }
  }
}
PublicTrialOffer
PublicTrialOffer
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "googleSearchRequests",
    "youtubeDataRequests",
    "downloadGigabytes"
  ],
  "properties": {
    "maxApiRequests": {
      "type": "integer",
      "minimum": 0,
      "description": "Maximum free API calls when the entire trial grant is spent on the lowest-cost per-request API at current Pay as you go rates. Other APIs may allow fewer calls. Downloads are billed by delivered bytes and excluded from this count."
    },
    "googleSearchRequests": {
      "type": "integer",
      "minimum": 0,
      "description": "Requests if the entire grant is spent on Google sources, using the highest current source rate."
    },
    "youtubeDataRequests": {
      "type": "integer",
      "minimum": 0,
      "description": "Standard YouTube requests, excluding Extended Search, using the highest current source rate."
    },
    "downloadGigabytes": {
      "type": "number",
      "minimum": 0,
      "description": "Approximate delivered media volume in decimal GB (1 GB = 1000000000 bytes). Zero when the grant cannot cover the initial download reservation. Completion also depends on per-job reservations and settlement."
    }
  }
}
QueryRepresentationError
QueryRepresentationError
{
  "type": "object",
  "required": [
    "error",
    "code",
    "message"
  ],
  "properties": {
    "error": {
      "type": "boolean",
      "const": true
    },
    "code": {
      "type": "string",
      "enum": [
        "unsupported_representation",
        "not_acceptable"
      ]
    },
    "message": {
      "type": "string"
    }
  }
}
Reauthentication
Reauthentication
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "reauthenticatedUntil"
  ],
  "properties": {
    "reauthenticatedUntil": {
      "type": "string",
      "format": "date-time"
    }
  }
}
RegisterRequest
RegisterRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email",
    "password",
    "acceptedTerms",
    "termsVersion",
    "privacyVersion"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "Optional display name. When omitted, defaults to the normalized email local part, truncated to 100 characters. Can be changed in the profile later."
    },
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 320
    },
    "password": {
      "$ref": "#/components/schemas/Password"
    },
    "acceptedTerms": {
      "type": "boolean",
      "const": true
    },
    "termsVersion": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Exact version rendered by the signup page; stale versions are rejected."
    },
    "privacyVersion": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Exact version rendered by the signup page; stale versions are rejected."
    }
  }
}
RegisterResponse
RegisterResponse
{
  "type": "object",
  "additionalProperties": false,
  "description": "Generic receipt returned for both a new account and a recoverable pending account. It intentionally omits identity data to limit account enumeration.",
  "required": [
    "emailVerificationRequired"
  ],
  "properties": {
    "emailVerificationRequired": {
      "type": "boolean",
      "const": true
    }
  }
}
Session
Session
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "current",
    "mode",
    "createdAt",
    "lastSeenAt",
    "expiresAt",
    "device"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^ses_"
    },
    "current": {
      "type": "boolean"
    },
    "mode": {
      "type": "string",
      "enum": [
        "full",
        "email_verification",
        "legal_acceptance",
        "deletion_recovery"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "lastSeenAt": {
      "type": "string",
      "format": "date-time"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "device": {
      "type": "string"
    },
    "approximateLocation": {
      "type": "string"
    },
    "reauthenticatedUntil": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}
Subscription
Subscription
{
  "type": "object",
  "description": "Effective entitlement projection. `status=payg` and `id=null` means no billing subscription record exists.",
  "additionalProperties": false,
  "required": [
    "status",
    "plan",
    "cancelAtPeriodEnd",
    "usageRates"
  ],
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^sub_"
    },
    "status": {
      "type": "string",
      "enum": [
        "payg",
        "trialing",
        "active",
        "past_due",
        "grace",
        "cancelled"
      ]
    },
    "plan": {
      "$ref": "#/components/schemas/Plan"
    },
    "usageRates": {
      "type": "object",
      "description": "Account-specific configured credit rates. Query rates come from the account entitlement, not the public plan catalog. One TB is 1,000,000,000,000 bytes; download charges are settled against actual bytes and rounded per result.",
      "additionalProperties": false,
      "required": [
        "customized",
        "queries",
        "downloadCreditsPerTb"
      ],
      "properties": {
        "customized": {
          "type": "boolean",
          "description": "True when an administrator configured rates for this account."
        },
        "queries": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "source",
              "name",
              "creditsPerRequest"
            ],
            "properties": {
              "source": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "creditsPerRequest": {
                "type": "number",
                "minimum": 0
              }
            }
          }
        },
        "downloadCreditsPerTb": {
          "type": "number",
          "minimum": 0
        }
      }
    },
    "currentPeriodStart": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "currentPeriodEnd": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "cancelAtPeriodEnd": {
      "type": "boolean"
    },
    "graceEndsAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}
SubscriptionCancellationChange
SubscriptionCancellationChange
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "cancelAtPeriodEnd",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^sub_"
    },
    "cancelAtPeriodEnd": {
      "type": "boolean"
    },
    "status": {
      "type": "string",
      "enum": [
        "submitted"
      ]
    }
  }
}
SubscriptionChange
SubscriptionChange
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "fromPriceId",
    "toPriceId",
    "effective",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^sub_",
      "description": "FlashData subscription public ID. Entitlement still updates only after a verified provider event."
    },
    "fromPriceId": {
      "type": "string",
      "pattern": "^prc_"
    },
    "toPriceId": {
      "type": "string",
      "pattern": "^prc_"
    },
    "effective": {
      "type": "string",
      "enum": [
        "immediate"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "submitted"
      ]
    }
  }
}
TokenRequest
TokenRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "token"
  ],
  "properties": {
    "token": {
      "type": "string",
      "minLength": 32,
      "maxLength": 256,
      "writeOnly": true
    }
  }
}
TrialCreditState
TrialCreditState
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "eligible",
    "ineligibilityReason",
    "grantCredits",
    "settingsVersion",
    "request"
  ],
  "properties": {
    "eligible": {
      "type": "boolean"
    },
    "ineligibilityReason": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "account_inactive",
        "email_unverified",
        "onboarding_incomplete",
        "not_payg",
        "payment_history",
        "already_granted",
        "already_requested",
        null
      ]
    },
    "grantCredits": {
      "type": "integer",
      "minimum": 1
    },
    "settingsVersion": {
      "type": "integer",
      "minimum": 0
    },
    "request": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TrialCreditRequest"
        },
        {
          "type": "null"
        }
      ]
    }
  }
}
TrialCreditRequest
TrialCreditRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "status",
    "requestedCredits",
    "policyVersion",
    "useCase",
    "requestedAt",
    "reviewedAt",
    "reviewReason",
    "version"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^tcr_[A-Za-z0-9_-]{8,}$"
    },
    "status": {
      "$ref": "#/components/schemas/TrialCreditRequestStatus"
    },
    "requestedCredits": {
      "type": "integer",
      "minimum": 1
    },
    "policyVersion": {
      "type": "integer",
      "minimum": 0
    },
    "useCase": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "google_search",
        "youtube_data",
        "download",
        null
      ]
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time"
    },
    "reviewedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "reviewReason": {
      "type": [
        "string",
        "null"
      ]
    },
    "version": {
      "type": "integer",
      "minimum": 0
    }
  }
}
TrialCreditRequestStatus
TrialCreditRequestStatus
{
  "type": "string",
  "enum": [
    "pending",
    "approved",
    "rejected"
  ]
}
UpdateAccountRequest
UpdateAccountRequest
{
  "type": "object",
  "additionalProperties": false,
  "minProperties": 1,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    }
  }
}
UpdateBulkJobRequest
UpdateBulkJobRequest
{
  "type": "object",
  "additionalProperties": false,
  "minProperties": 1,
  "properties": {
    "options": {
      "type": "object",
      "additionalProperties": true,
      "description": "Partial option update. Nested storage fields are merged so unchanged credentials do not need to be resent. Data result_storage fields are merged the same way. After all IDs have been scanned, a paused data bulk job accepts credential updates only: access_key and secret_key, GCS service_account, or Azure sas_token, depending on the storage type. The complete merged configuration is validated before it is stored."
    },
    "callback_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "maxLength": 2048,
      "description": "Replacement completion callback, or null to remove the callback."
    }
  }
}
UpdateOnboardingRequest
UpdateOnboardingRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "version",
    "action"
  ],
  "properties": {
    "version": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "action": {
      "type": "string",
      "enum": [
        "select_use_case",
        "confirm_api_key_saved",
        "skip_api_key",
        "confirm_first_request",
        "skip_first_request"
      ]
    },
    "useCase": {
      "type": "string",
      "enum": [
        "google_search",
        "youtube_data",
        "download"
      ]
    }
  },
  "allOf": [
    {
      "if": {
        "properties": {
          "action": {
            "const": "select_use_case"
          }
        }
      },
      "then": {
        "required": [
          "useCase"
        ],
        "properties": {
          "useCase": {}
        }
      },
      "else": {
        "not": {
          "required": [
            "useCase"
          ],
          "properties": {
            "useCase": {}
          }
        }
      }
    }
  ],
  "description": "Server-owned resource state validates confirmation actions; clients never submit API Key or request IDs."
}
UsageCounts
UsageCounts
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "requests",
    "completed",
    "failed",
    "credits"
  ],
  "properties": {
    "requests": {
      "type": "integer",
      "minimum": 0
    },
    "completed": {
      "type": "integer",
      "minimum": 0
    },
    "failed": {
      "type": "integer",
      "minimum": 0
    },
    "credits": {
      "type": "number",
      "minimum": 0,
      "description": "Charged Credits in the current aggregate; pending work may not be finally settled."
    }
  }
}