mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-07-31 12:30:30 +08:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 OpenRouter Team
|
9193488c2b |
+1
-3
@@ -1,3 +1 @@
|
|||||||
pylintrc
|
pylintrc
|
||||||
docs/docs.json
|
|
||||||
docs/overview.mdx
|
|
||||||
@@ -1,225 +0,0 @@
|
|||||||
name: Auto-merge Speakeasy PR
|
|
||||||
|
|
||||||
# Called as a follow-up job after Speakeasy Generate (mode: pr). Merges the
|
|
||||||
# regen PR opened/updated in the same workflow run so sdk_publish.yaml can run.
|
|
||||||
# Prefer branch_name from Generate logs; fall back to run_started_at heuristics.
|
|
||||||
# Uses GH_DOCS_SYNC GitHub App token (not a PAT) so merges trigger downstream push.
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_call:
|
|
||||||
inputs:
|
|
||||||
run_started_at:
|
|
||||||
description: ISO timestamp when the parent Generate workflow run started
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
branch_name:
|
|
||||||
description: Speakeasy regen branch from the parent Generate run (optional)
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
default: ""
|
|
||||||
secrets:
|
|
||||||
GH_DOCS_SYNC_APP_ID:
|
|
||||||
required: true
|
|
||||||
GH_DOCS_SYNC_APP_PRIVATE_KEY:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
|
|
||||||
concurrency:
|
|
||||||
group: auto-merge-speakeasy
|
|
||||||
cancel-in-progress: false
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
auto-merge:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Generate GitHub App token
|
|
||||||
id: app-token
|
|
||||||
# actions/create-github-app-token@v3.2.0 (immutable SHA)
|
|
||||||
uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1
|
|
||||||
with:
|
|
||||||
app-id: ${{ secrets.GH_DOCS_SYNC_APP_ID }}
|
|
||||||
private-key: ${{ secrets.GH_DOCS_SYNC_APP_PRIVATE_KEY }}
|
|
||||||
|
|
||||||
- name: Resolve Speakeasy regen PR
|
|
||||||
id: pr
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ steps.app-token.outputs.token }}
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
REPO="${{ github.repository }}"
|
|
||||||
RUN_STARTED="${{ inputs.run_started_at }}"
|
|
||||||
BRANCH="${{ inputs.branch_name }}"
|
|
||||||
|
|
||||||
PR_JSON=$(gh pr list \
|
|
||||||
--repo "$REPO" \
|
|
||||||
--state open \
|
|
||||||
--search "head:speakeasy-sdk-regen-" \
|
|
||||||
--limit 500 \
|
|
||||||
--json number,updatedAt,title,labels,author,headRefName)
|
|
||||||
|
|
||||||
PR_NUM=""
|
|
||||||
if [ -n "$BRANCH" ]; then
|
|
||||||
CANDIDATE=$(echo "$PR_JSON" | jq -r --arg branch "$BRANCH" \
|
|
||||||
'[.[] | select(.headRefName == $branch)] | .[0] // empty')
|
|
||||||
if [ -n "$CANDIDATE" ] && echo "$CANDIDATE" | jq -e '
|
|
||||||
(.headRefName | startswith("speakeasy-sdk-regen-"))
|
|
||||||
and (.title | contains("🐝 Update SDK"))
|
|
||||||
and ([.labels[].name] | any(. == "patch" or . == "minor" or . == "major"))
|
|
||||||
and (.author.is_bot == true)
|
|
||||||
' > /dev/null; then
|
|
||||||
PR_NUM=$(echo "$CANDIDATE" | jq -r '.number')
|
|
||||||
echo "Resolved Speakeasy regen PR #$PR_NUM from branch $BRANCH"
|
|
||||||
else
|
|
||||||
echo "::warning::branch_name=$BRANCH did not match a valid open regen PR — falling back to run_started_at"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -z "$PR_NUM" ]; then
|
|
||||||
PR_NUM=$(echo "$PR_JSON" | jq -r --arg started "$RUN_STARTED" '
|
|
||||||
[.[]
|
|
||||||
| select(.headRefName | startswith("speakeasy-sdk-regen-"))
|
|
||||||
| select(.title | contains("🐝 Update SDK"))
|
|
||||||
| select([.labels[].name] | any(. == "patch" or . == "minor" or . == "major"))
|
|
||||||
| select(.author.is_bot == true)
|
|
||||||
| select(.updatedAt >= $started)
|
|
||||||
] | sort_by(.updatedAt) | last | .number // empty')
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -z "$PR_NUM" ]; then
|
|
||||||
echo "No Speakeasy regen PR for this Generate run — skipping auto-merge"
|
|
||||||
echo "::notice title=auto-merge-skipped::No qualifying Speakeasy regen PR to merge"
|
|
||||||
{
|
|
||||||
echo "## Auto-merge skipped"
|
|
||||||
echo "No qualifying \`speakeasy-sdk-regen-*\` PR was found."
|
|
||||||
echo "- branch_name input: \`${BRANCH:-<empty>}\`"
|
|
||||||
echo "- run_started_at: \`$RUN_STARTED\`"
|
|
||||||
} >> "$GITHUB_STEP_SUMMARY"
|
|
||||||
echo "pr_num=" >> "$GITHUB_OUTPUT"
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "pr_num=$PR_NUM" >> "$GITHUB_OUTPUT"
|
|
||||||
echo "$PR_JSON" > /tmp/speakeasy_pr_json.json
|
|
||||||
|
|
||||||
- name: Close superseded Speakeasy PRs
|
|
||||||
if: steps.pr.outputs.pr_num != ''
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ steps.app-token.outputs.token }}
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
CURRENT_PR="${{ steps.pr.outputs.pr_num }}"
|
|
||||||
PR_JSON=$(cat /tmp/speakeasy_pr_json.json)
|
|
||||||
|
|
||||||
PRIOR_JSON=$(echo "$PR_JSON" | jq -r --arg current_pr "$CURRENT_PR" \
|
|
||||||
'[.[].number | select(tostring != $current_pr)] | .[]')
|
|
||||||
|
|
||||||
if [ -z "$PRIOR_JSON" ]; then
|
|
||||||
echo "No superseded Speakeasy PRs to close"
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
mapfile -t PRIOR <<< "$PRIOR_JSON"
|
|
||||||
|
|
||||||
echo "Closing ${#PRIOR[@]} superseded Speakeasy PR(s)"
|
|
||||||
for N in "${PRIOR[@]}"; do
|
|
||||||
gh pr close "$N" --repo "${{ github.repository }}" --delete-branch \
|
|
||||||
--comment "Superseded by newer Speakeasy SDK generation PR #${CURRENT_PR}" \
|
|
||||||
|| echo "::warning::Failed to close PR #$N (continuing)"
|
|
||||||
sleep 1
|
|
||||||
done
|
|
||||||
|
|
||||||
- name: Auto-merge Speakeasy PR
|
|
||||||
if: steps.pr.outputs.pr_num != ''
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ steps.app-token.outputs.token }}
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
PR_NUM="${{ steps.pr.outputs.pr_num }}"
|
|
||||||
REPO="${{ github.repository }}"
|
|
||||||
|
|
||||||
wait_for_checks() {
|
|
||||||
local pr=$1
|
|
||||||
local timeout=600
|
|
||||||
local interval=15
|
|
||||||
local elapsed=0
|
|
||||||
|
|
||||||
echo "Waiting for PR #$pr checks (timeout ${timeout}s)..."
|
|
||||||
while [ "$elapsed" -lt "$timeout" ]; do
|
|
||||||
TOTAL=$(gh pr view "$pr" --repo "$REPO" --json statusCheckRollup --jq \
|
|
||||||
'.statusCheckRollup | length')
|
|
||||||
PENDING=$(gh pr view "$pr" --repo "$REPO" --json statusCheckRollup --jq \
|
|
||||||
'[.statusCheckRollup[]? | select(.status != "COMPLETED")] | length')
|
|
||||||
FAILED=$(gh pr view "$pr" --repo "$REPO" --json statusCheckRollup --jq \
|
|
||||||
'[.statusCheckRollup[]? | select(.status == "COMPLETED") | select(.conclusion != "SUCCESS" and .conclusion != "SKIPPED" and .conclusion != "NEUTRAL")] | length')
|
|
||||||
|
|
||||||
if [ "$TOTAL" -eq 0 ]; then
|
|
||||||
# GITHUB_TOKEN-authored regen PRs get no pull_request checks at all,
|
|
||||||
# so TOTAL stays 0 forever. Wait a short grace window in case checks
|
|
||||||
# are merely slow to register, then proceed rather than time out.
|
|
||||||
if [ "$elapsed" -ge 60 ]; then
|
|
||||||
echo "No checks registered after ${elapsed}s — proceeding (checkless PR)"
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
echo "Checks not yet registered — waiting ${interval}s..."
|
|
||||||
sleep "$interval"
|
|
||||||
elapsed=$((elapsed + interval))
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$PENDING" -eq 0 ]; then
|
|
||||||
if [ "$FAILED" -gt 0 ]; then
|
|
||||||
echo "::error::PR #$pr has failing checks — refusing direct merge"
|
|
||||||
gh pr checks "$pr" --repo "$REPO" || true
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
echo "All checks completed"
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Checks pending ($PENDING) — waiting ${interval}s..."
|
|
||||||
sleep "$interval"
|
|
||||||
elapsed=$((elapsed + interval))
|
|
||||||
done
|
|
||||||
|
|
||||||
echo "::error::Timed out waiting for PR #$pr checks"
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
STATE=$(gh pr view "$PR_NUM" --repo "$REPO" --json state --jq .state)
|
|
||||||
if [ "$STATE" != "OPEN" ]; then
|
|
||||||
echo "PR #$PR_NUM is $STATE — skipping merge"
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
MERGE_METHOD=""
|
|
||||||
# Prefer GitHub auto-merge when required checks exist; otherwise
|
|
||||||
# squash-merge directly after checks pass (sdk-release-prs.yaml pattern).
|
|
||||||
AUTO_MERGE_NOOP_PATTERN='is in clean status|protected branch rules|Branch does not have required protected branch rules'
|
|
||||||
if gh pr merge "$PR_NUM" --repo "$REPO" --squash --auto --delete-branch 2> /tmp/gh-merge.err; then
|
|
||||||
MERGE_METHOD="auto-merge queued"
|
|
||||||
echo "Auto-merge enabled for Speakeasy PR #$PR_NUM"
|
|
||||||
elif grep -qiE "$AUTO_MERGE_NOOP_PATTERN" /tmp/gh-merge.err; then
|
|
||||||
echo "Auto-merge not applicable — waiting for checks, then merging PR #$PR_NUM directly"
|
|
||||||
cat /tmp/gh-merge.err >&2
|
|
||||||
wait_for_checks "$PR_NUM"
|
|
||||||
gh pr merge "$PR_NUM" --repo "$REPO" --squash --delete-branch
|
|
||||||
MERGE_METHOD="direct squash (checks passed)"
|
|
||||||
else
|
|
||||||
echo "::error::Failed to enable auto-merge on Speakeasy PR #$PR_NUM"
|
|
||||||
cat /tmp/gh-merge.err >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "::notice title=auto-merge-pr::Merged Speakeasy PR #$PR_NUM ($MERGE_METHOD)"
|
|
||||||
{
|
|
||||||
echo "## Auto-merge complete"
|
|
||||||
echo "- PR: #$PR_NUM"
|
|
||||||
echo "- Method: $MERGE_METHOD"
|
|
||||||
echo "- Token: GH_DOCS_SYNC GitHub App"
|
|
||||||
} >> "$GITHUB_STEP_SUMMARY"
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
name: Docs navigation
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- "docs/sdks/**"
|
|
||||||
- "scripts/gen-docs-nav.sh"
|
|
||||||
- ".github/workflows/docs-nav.yaml"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
gen-docs-nav:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v5
|
|
||||||
with:
|
|
||||||
ref: ${{ github.event.pull_request.head.ref }}
|
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
# jq is preinstalled on GitHub-hosted ubuntu runners.
|
|
||||||
- name: Regenerate docs navigation
|
|
||||||
run: scripts/gen-docs-nav.sh
|
|
||||||
|
|
||||||
- name: Auto-commit docs.json navigation
|
|
||||||
uses: int128/update-generated-files-action@v2
|
|
||||||
with:
|
|
||||||
commit-message: "Chore: regenerate docs navigation"
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
name: PR Validation
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths-ignore:
|
|
||||||
- .speakeasy/in.openapi.yaml
|
|
||||||
|
|
||||||
concurrency:
|
|
||||||
group: pr-validation-${{ github.event.pull_request.number }}
|
|
||||||
cancel-in-progress: true
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
validate:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v5
|
|
||||||
|
|
||||||
- name: Install uv
|
|
||||||
uses: astral-sh/setup-uv@v5
|
|
||||||
with:
|
|
||||||
enable-cache: true
|
|
||||||
|
|
||||||
- name: Build SDK
|
|
||||||
run: uv build
|
|
||||||
|
|
||||||
- name: Type check (mypy)
|
|
||||||
run: uv run --group dev mypy src
|
|
||||||
|
|
||||||
- name: Type check (pyright)
|
|
||||||
run: uv run --group dev pyright src
|
|
||||||
|
|
||||||
- name: Lint (pylint)
|
|
||||||
run: uv run --group dev pylint src --rcfile pylintrc
|
|
||||||
@@ -21,11 +21,6 @@ permissions:
|
|||||||
types:
|
types:
|
||||||
- labeled
|
- labeled
|
||||||
- unlabeled
|
- unlabeled
|
||||||
|
|
||||||
concurrency:
|
|
||||||
group: speakeasy-generate
|
|
||||||
cancel-in-progress: false
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
generate:
|
generate:
|
||||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||||
@@ -37,67 +32,3 @@ jobs:
|
|||||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
pypi_token: ${{ secrets.PYPI_TOKEN }}
|
pypi_token: ${{ secrets.PYPI_TOKEN }}
|
||||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||||
|
|
||||||
resolve-branch:
|
|
||||||
needs: generate
|
|
||||||
if: ${{ !cancelled() && needs.generate.result == 'success' }}
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
outputs:
|
|
||||||
branch_name: ${{ steps.branch.outputs.branch_name }}
|
|
||||||
run_started_at: ${{ steps.branch.outputs.run_started_at }}
|
|
||||||
steps:
|
|
||||||
- name: Extract branch from Generate logs
|
|
||||||
id: branch
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ github.token }}
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
REPO="${{ github.repository }}"
|
|
||||||
RUN_ID="${{ github.run_id }}"
|
|
||||||
|
|
||||||
RUN_STARTED="${{ github.run_started_at }}"
|
|
||||||
if [ -z "$RUN_STARTED" ]; then
|
|
||||||
RUN_STARTED=$(gh run view "$RUN_ID" --repo "$REPO" --json startedAt --jq '.startedAt')
|
|
||||||
echo "Resolved run_started_at from API: $RUN_STARTED"
|
|
||||||
fi
|
|
||||||
echo "run_started_at=$RUN_STARTED" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
# Full-run logs are unavailable while the workflow is in progress;
|
|
||||||
# fetch logs from the completed generate job instead.
|
|
||||||
JOB_ID=$(gh run view "$RUN_ID" --repo "$REPO" --json jobs --jq \
|
|
||||||
'[.jobs[] | select(.name == "generate / Generate Target")] | .[0].databaseId // empty')
|
|
||||||
|
|
||||||
BRANCH=""
|
|
||||||
if [ -z "$JOB_ID" ]; then
|
|
||||||
echo "::warning::Could not find generate job id — auto-merge will use run_started_at fallback"
|
|
||||||
else
|
|
||||||
MAX_ATTEMPTS=12
|
|
||||||
INTERVAL=10
|
|
||||||
for attempt in $(seq 1 "$MAX_ATTEMPTS"); do
|
|
||||||
BRANCH=$(gh run view "$RUN_ID" --repo "$REPO" --job "$JOB_ID" --log 2>/dev/null \
|
|
||||||
| grep -oE 'branch_name=speakeasy-sdk-regen-[0-9]+' | tail -1 | cut -d= -f2 || true)
|
|
||||||
if [ -n "$BRANCH" ]; then
|
|
||||||
echo "Extracted branch_name=$BRANCH (attempt $attempt)"
|
|
||||||
break
|
|
||||||
fi
|
|
||||||
if [ "$attempt" -lt "$MAX_ATTEMPTS" ]; then
|
|
||||||
echo "Job logs not ready — waiting ${INTERVAL}s (attempt $attempt/$MAX_ATTEMPTS)..."
|
|
||||||
sleep "$INTERVAL"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
if [ -z "$BRANCH" ]; then
|
|
||||||
echo "::warning::Could not extract branch_name from Generate logs after ${MAX_ATTEMPTS} attempts — auto-merge will use run_started_at fallback"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
echo "branch_name=$BRANCH" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
auto-merge:
|
|
||||||
needs: [generate, resolve-branch]
|
|
||||||
if: ${{ !cancelled() && needs.generate.result == 'success' }}
|
|
||||||
uses: ./.github/workflows/auto-merge-speakeasy-pr.yaml
|
|
||||||
with:
|
|
||||||
run_started_at: ${{ needs.resolve-branch.outputs.run_started_at }}
|
|
||||||
branch_name: ${{ needs.resolve-branch.outputs.branch_name }}
|
|
||||||
secrets:
|
|
||||||
GH_DOCS_SYNC_APP_ID: ${{ secrets.GH_DOCS_SYNC_APP_ID }}
|
|
||||||
GH_DOCS_SYNC_APP_PRIVATE_KEY: ${{ secrets.GH_DOCS_SYNC_APP_PRIVATE_KEY }}
|
|
||||||
|
|||||||
@@ -1,104 +0,0 @@
|
|||||||
name: Generate (spec change merged)
|
|
||||||
permissions:
|
|
||||||
checks: write
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
statuses: write
|
|
||||||
id-token: write
|
|
||||||
"on":
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
force:
|
|
||||||
description: Force generation of SDKs
|
|
||||||
type: boolean
|
|
||||||
default: false
|
|
||||||
set_version:
|
|
||||||
description: optionally set a specific SDK version
|
|
||||||
type: string
|
|
||||||
pull_request:
|
|
||||||
types: [closed]
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths:
|
|
||||||
- .speakeasy/in.openapi.yaml
|
|
||||||
|
|
||||||
concurrency:
|
|
||||||
group: speakeasy-generate-spec-change
|
|
||||||
cancel-in-progress: false
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
generate:
|
|
||||||
if: github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch'
|
|
||||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
|
||||||
with:
|
|
||||||
force: ${{ github.event.inputs.force }}
|
|
||||||
mode: pr
|
|
||||||
set_version: ${{ github.event.inputs.set_version }}
|
|
||||||
secrets:
|
|
||||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
pypi_token: ${{ secrets.PYPI_TOKEN }}
|
|
||||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
|
||||||
|
|
||||||
resolve-branch:
|
|
||||||
needs: generate
|
|
||||||
if: ${{ !cancelled() && needs.generate.result == 'success' }}
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
outputs:
|
|
||||||
branch_name: ${{ steps.branch.outputs.branch_name }}
|
|
||||||
run_started_at: ${{ steps.branch.outputs.run_started_at }}
|
|
||||||
steps:
|
|
||||||
- name: Extract branch from Generate logs
|
|
||||||
id: branch
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ github.token }}
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
REPO="${{ github.repository }}"
|
|
||||||
RUN_ID="${{ github.run_id }}"
|
|
||||||
|
|
||||||
RUN_STARTED="${{ github.run_started_at }}"
|
|
||||||
if [ -z "$RUN_STARTED" ]; then
|
|
||||||
RUN_STARTED=$(gh run view "$RUN_ID" --repo "$REPO" --json startedAt --jq '.startedAt')
|
|
||||||
echo "Resolved run_started_at from API: $RUN_STARTED"
|
|
||||||
fi
|
|
||||||
echo "run_started_at=$RUN_STARTED" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
# Full-run logs are unavailable while the workflow is in progress;
|
|
||||||
# fetch logs from the completed generate job instead.
|
|
||||||
JOB_ID=$(gh run view "$RUN_ID" --repo "$REPO" --json jobs --jq \
|
|
||||||
'[.jobs[] | select(.name == "generate / Generate Target")] | .[0].databaseId // empty')
|
|
||||||
|
|
||||||
BRANCH=""
|
|
||||||
if [ -z "$JOB_ID" ]; then
|
|
||||||
echo "::warning::Could not find generate job id — auto-merge will use run_started_at fallback"
|
|
||||||
else
|
|
||||||
MAX_ATTEMPTS=12
|
|
||||||
INTERVAL=10
|
|
||||||
for attempt in $(seq 1 "$MAX_ATTEMPTS"); do
|
|
||||||
BRANCH=$(gh run view "$RUN_ID" --repo "$REPO" --job "$JOB_ID" --log 2>/dev/null \
|
|
||||||
| grep -oE 'branch_name=speakeasy-sdk-regen-[0-9]+' | tail -1 | cut -d= -f2 || true)
|
|
||||||
if [ -n "$BRANCH" ]; then
|
|
||||||
echo "Extracted branch_name=$BRANCH (attempt $attempt)"
|
|
||||||
break
|
|
||||||
fi
|
|
||||||
if [ "$attempt" -lt "$MAX_ATTEMPTS" ]; then
|
|
||||||
echo "Job logs not ready — waiting ${INTERVAL}s (attempt $attempt/$MAX_ATTEMPTS)..."
|
|
||||||
sleep "$INTERVAL"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
if [ -z "$BRANCH" ]; then
|
|
||||||
echo "::warning::Could not extract branch_name from Generate logs after ${MAX_ATTEMPTS} attempts — auto-merge will use run_started_at fallback"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
echo "branch_name=$BRANCH" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
auto-merge:
|
|
||||||
needs: [generate, resolve-branch]
|
|
||||||
if: ${{ !cancelled() && needs.generate.result == 'success' }}
|
|
||||||
uses: ./.github/workflows/auto-merge-speakeasy-pr.yaml
|
|
||||||
with:
|
|
||||||
run_started_at: ${{ needs.resolve-branch.outputs.run_started_at }}
|
|
||||||
branch_name: ${{ needs.resolve-branch.outputs.branch_name }}
|
|
||||||
secrets:
|
|
||||||
GH_DOCS_SYNC_APP_ID: ${{ secrets.GH_DOCS_SYNC_APP_ID }}
|
|
||||||
GH_DOCS_SYNC_APP_PRIVATE_KEY: ${{ secrets.GH_DOCS_SYNC_APP_PRIVATE_KEY }}
|
|
||||||
+2
-13
@@ -1,24 +1,13 @@
|
|||||||
|
.venv/
|
||||||
venv/
|
venv/
|
||||||
src/*.egg-info/
|
src/*.egg-info/
|
||||||
**/__pycache__/
|
**/__pycache__/
|
||||||
.pytest_cache/
|
.pytest_cache/
|
||||||
.python-version
|
.python-version
|
||||||
|
.DS_Store
|
||||||
pyrightconfig.json
|
pyrightconfig.json
|
||||||
**/.speakeasy/temp/
|
**/.speakeasy/temp/
|
||||||
**/.speakeasy/logs/
|
**/.speakeasy/logs/
|
||||||
.speakeasy/reports
|
.speakeasy/reports
|
||||||
# Build artifacts
|
|
||||||
/dist
|
|
||||||
__pycache__/
|
|
||||||
*.py[cod]
|
|
||||||
*.egg-info/
|
|
||||||
*.egg
|
|
||||||
# Speakeasy generation artifacts (generated in OSS repo, not here)
|
|
||||||
.speakeasy/*.lock
|
|
||||||
.speakeasy/*.openapi.yaml
|
|
||||||
# Environment
|
|
||||||
.env
|
.env
|
||||||
.env.local
|
.env.local
|
||||||
.env.*.local
|
|
||||||
.DS_Store
|
|
||||||
.venv/
|
|
||||||
|
|||||||
+1037
-10715
File diff suppressed because it is too large
Load Diff
+1
-23
@@ -16,8 +16,6 @@ generation:
|
|||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
securityFeb2025: true
|
securityFeb2025: true
|
||||||
sharedErrorComponentsApr2025: true
|
sharedErrorComponentsApr2025: true
|
||||||
sharedNestedComponentsJan2026: false
|
|
||||||
nameOverrideFeb2026: false
|
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: true
|
oAuth2PasswordEnabled: true
|
||||||
@@ -27,16 +25,13 @@ generation:
|
|||||||
schemas:
|
schemas:
|
||||||
allOfMergeStrategy: shallowMerge
|
allOfMergeStrategy: shallowMerge
|
||||||
requestBodyFieldName: ""
|
requestBodyFieldName: ""
|
||||||
versioningStrategy: automatic
|
|
||||||
persistentEdits: {}
|
|
||||||
tests:
|
tests:
|
||||||
generateTests: false
|
generateTests: false
|
||||||
generateNewTests: true
|
generateNewTests: true
|
||||||
skipResponseBodyAssertions: false
|
skipResponseBodyAssertions: false
|
||||||
documentation: mintlify
|
|
||||||
preApplyUnionDiscriminators: true
|
preApplyUnionDiscriminators: true
|
||||||
python:
|
python:
|
||||||
version: 0.11.33
|
version: 0.5.1
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dev: {}
|
dev: {}
|
||||||
main: {}
|
main: {}
|
||||||
@@ -50,27 +45,18 @@ python:
|
|||||||
authors:
|
authors:
|
||||||
- OpenRouter
|
- OpenRouter
|
||||||
baseErrorName: OpenRouterError
|
baseErrorName: OpenRouterError
|
||||||
bodyVariantOverloads: false
|
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
constFieldCasing: upper
|
|
||||||
defaultErrorName: OpenRouterDefaultError
|
defaultErrorName: OpenRouterDefaultError
|
||||||
description: Official Python Client SDK for OpenRouter.
|
description: Official Python Client SDK for OpenRouter.
|
||||||
enableCustomCodeRegions: false
|
enableCustomCodeRegions: false
|
||||||
enumFormat: union
|
enumFormat: union
|
||||||
envVarPrefix: OPENROUTER
|
envVarPrefix: OPENROUTER
|
||||||
errorSchemaValidation: true
|
|
||||||
eventStreamClassNames:
|
|
||||||
async: EventStreamAsync
|
|
||||||
sync: EventStream
|
|
||||||
fixFlags:
|
fixFlags:
|
||||||
asyncPaginationSep2025: true
|
asyncPaginationSep2025: true
|
||||||
conflictResistantModelImportsFeb2026: false
|
|
||||||
responseRequiredSep2024: true
|
responseRequiredSep2024: true
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
flattenRequests: true
|
flattenRequests: true
|
||||||
flatteningOrder: parameters-first
|
flatteningOrder: parameters-first
|
||||||
forwardCompatibleEnumsByDefault: false
|
|
||||||
forwardCompatibleUnionsByDefault: tagged-only
|
|
||||||
imports:
|
imports:
|
||||||
option: openapi
|
option: openapi
|
||||||
paths:
|
paths:
|
||||||
@@ -82,25 +68,17 @@ python:
|
|||||||
inferSSEOverload: true
|
inferSSEOverload: true
|
||||||
inferUnionDiscriminators: true
|
inferUnionDiscriminators: true
|
||||||
inputModelSuffix: input
|
inputModelSuffix: input
|
||||||
inputTypedDictSuffix: TypedDict
|
|
||||||
legacyPyright: false
|
legacyPyright: false
|
||||||
license: Apache-2.0
|
license: Apache-2.0
|
||||||
maxMethodParams: 999
|
maxMethodParams: 999
|
||||||
methodArguments: infer-optional-args
|
methodArguments: infer-optional-args
|
||||||
methodTimeoutArgument: timeout-ms
|
|
||||||
methodTimeoutUnits: milliseconds
|
|
||||||
moduleName: ""
|
moduleName: ""
|
||||||
multipartArrayFormat: legacy
|
multipartArrayFormat: legacy
|
||||||
optionalDependencies: {}
|
|
||||||
outputModelSuffix: output
|
outputModelSuffix: output
|
||||||
packageManager: uv
|
packageManager: uv
|
||||||
packageName: openrouter
|
packageName: openrouter
|
||||||
preApplyUnionDiscriminators: false
|
|
||||||
pytestFilterWarnings: []
|
pytestFilterWarnings: []
|
||||||
pytestTimeout: 0
|
pytestTimeout: 0
|
||||||
rawResponseHelpers: false
|
|
||||||
responseFormat: flat
|
responseFormat: flat
|
||||||
responseSchemaValidation: true
|
|
||||||
sseFlatResponse: true
|
sseFlatResponse: true
|
||||||
templateVersion: v2
|
templateVersion: v2
|
||||||
useAsyncHooks: false
|
|
||||||
|
|||||||
+12684
-34698
File diff suppressed because it is too large
Load Diff
+12720
-34534
File diff suppressed because it is too large
Load Diff
@@ -1,18 +1,17 @@
|
|||||||
overlay: 1.0.0
|
overlay: 1.0.0
|
||||||
x-speakeasy-jsonpath: rfc9535
|
x-speakeasy-jsonpath: rfc9535
|
||||||
info:
|
info:
|
||||||
title: Add HTTP-Referer and X-OpenRouter-Title as global parameters
|
title: Add HTTP-Referer and X-Title as global parameters
|
||||||
version: 0.0.0
|
version: 0.0.0
|
||||||
actions:
|
actions:
|
||||||
# Add global parameters for app identification
|
# Add global parameters for app identification
|
||||||
- target: $
|
- target: $
|
||||||
description: Add x-speakeasy-globals for HTTP-Referer, X-OpenRouter-Title, and X-OpenRouter-Categories headers
|
description: Add x-speakeasy-globals for HTTP-Referer and X-Title headers
|
||||||
update:
|
update:
|
||||||
x-speakeasy-globals:
|
x-speakeasy-globals:
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/AppIdentifier"
|
- $ref: "#/components/parameters/AppIdentifier"
|
||||||
- $ref: "#/components/parameters/AppDisplayName"
|
- $ref: "#/components/parameters/AppDisplayName"
|
||||||
- $ref: "#/components/parameters/AppCategories"
|
|
||||||
|
|
||||||
# Add component parameters
|
# Add component parameters
|
||||||
- target: $.components
|
- target: $.components
|
||||||
@@ -28,19 +27,12 @@ actions:
|
|||||||
The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
||||||
This is used to track API usage per application.
|
This is used to track API usage per application.
|
||||||
AppDisplayName:
|
AppDisplayName:
|
||||||
name: X-OpenRouter-Title
|
name: X-Title
|
||||||
in: header
|
in: header
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
||||||
AppCategories:
|
|
||||||
name: X-OpenRouter-Categories
|
|
||||||
in: header
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: |
|
|
||||||
Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
|
|
||||||
|
|
||||||
# Add header parameters to all paths so Speakeasy matches them with globals
|
# Add header parameters to all paths so Speakeasy matches them with globals
|
||||||
- target: $.paths[*]
|
- target: $.paths[*]
|
||||||
@@ -49,4 +41,3 @@ actions:
|
|||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/AppIdentifier"
|
- $ref: "#/components/parameters/AppIdentifier"
|
||||||
- $ref: "#/components/parameters/AppDisplayName"
|
- $ref: "#/components/parameters/AppDisplayName"
|
||||||
- $ref: "#/components/parameters/AppCategories"
|
|
||||||
|
|||||||
@@ -1,11 +0,0 @@
|
|||||||
overlay: 1.0.0
|
|
||||||
x-speakeasy-jsonpath: rfc9535
|
|
||||||
info:
|
|
||||||
title: Simplify redundant allOf inline schemas
|
|
||||||
version: 0.0.0
|
|
||||||
actions:
|
|
||||||
- target: "$..allOf[?@.enum && !@['$ref']]"
|
|
||||||
description: >
|
|
||||||
Remove inline enum definitions that duplicate a $ref enum in the same
|
|
||||||
allOf. These are artifacts from zod-openapi .extend() serialization.
|
|
||||||
remove: true
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
overlay: 1.0.0
|
|
||||||
x-speakeasy-jsonpath: rfc9535
|
|
||||||
info:
|
|
||||||
title: Convert boolean query params from string to boolean
|
|
||||||
version: 0.0.0
|
|
||||||
actions:
|
|
||||||
- target: $..parameters[?@.schema["x-openrouter-type"] == "boolean"].schema
|
|
||||||
description: Convert x-openrouter-type boolean params from string to boolean
|
|
||||||
update:
|
|
||||||
type: boolean
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
overlay: 1.0.0
|
|
||||||
x-speakeasy-jsonpath: rfc9535
|
|
||||||
info:
|
|
||||||
title: Fix nullable pagination params
|
|
||||||
version: 0.0.0
|
|
||||||
actions:
|
|
||||||
- target: $..parameters[?@.name == "offset" && @.in == "query"].schema
|
|
||||||
description: Remove nullable from offset query params to fix mypy errors in pagination helpers
|
|
||||||
update:
|
|
||||||
nullable: false
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
overlay: 1.0.0
|
|
||||||
x-speakeasy-jsonpath: rfc9535
|
|
||||||
info:
|
|
||||||
title: Retry request-timeout and rate-limit responses
|
|
||||||
version: 0.0.0
|
|
||||||
actions:
|
|
||||||
- target: $["x-speakeasy-retries"].statusCodes
|
|
||||||
description: Also retry 408 (request timeout) and 429 (rate limit), not just 5XX
|
|
||||||
update:
|
|
||||||
- "408"
|
|
||||||
- "429"
|
|
||||||
+15
-11
@@ -1,23 +1,30 @@
|
|||||||
speakeasyVersion: 1.787.0
|
speakeasyVersion: 1.666.0
|
||||||
sources:
|
sources:
|
||||||
OpenRouter API:
|
-OAS:
|
||||||
sourceNamespace: open-router-chat-completions-api
|
sourceNamespace: open-router-chat-completions-api
|
||||||
sourceRevisionDigest: sha256:1b18bfafe3a31635470908ce53c1bb12af21a82d371f6f979bb5e8463f52afb3
|
sourceRevisionDigest: sha256:01256c8494de6bfc13c36d82ae316a6a13d402194f844618bcd4d59e34f325f3
|
||||||
sourceBlobDigest: sha256:506597a9fce25fe757037a95da952e36f33dd702afa16c13d43c2df2d5da1ece
|
sourceBlobDigest: sha256:4c80e48fd5e1cd030e68d664eb93984b4d5946867252ff1755a2bd2a05eccd4e
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
|
OpenRouter API:
|
||||||
|
sourceNamespace: open-router-chat-completions-api
|
||||||
|
sourceRevisionDigest: sha256:9d0580abfbe319bbd1e3d51fa921b5c97134ae4ef84ee4b1254beb0e92bf4fd9
|
||||||
|
sourceBlobDigest: sha256:8555ff45ab0e3c22ae07af40cc4581ef14107b4d62c38bde3c25512fd4aae199
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- main
|
||||||
- 1.0.0
|
- 1.0.0
|
||||||
targets:
|
targets:
|
||||||
open-router:
|
open-router:
|
||||||
source: OpenRouter API
|
source: OpenRouter API
|
||||||
sourceNamespace: open-router-chat-completions-api
|
sourceNamespace: open-router-chat-completions-api
|
||||||
sourceRevisionDigest: sha256:1b18bfafe3a31635470908ce53c1bb12af21a82d371f6f979bb5e8463f52afb3
|
sourceRevisionDigest: sha256:9d0580abfbe319bbd1e3d51fa921b5c97134ae4ef84ee4b1254beb0e92bf4fd9
|
||||||
sourceBlobDigest: sha256:506597a9fce25fe757037a95da952e36f33dd702afa16c13d43c2df2d5da1ece
|
sourceBlobDigest: sha256:8555ff45ab0e3c22ae07af40cc4581ef14107b4d62c38bde3c25512fd4aae199
|
||||||
codeSamplesNamespace: open-router-python-code-samples
|
codeSamplesNamespace: open-router-python-code-samples
|
||||||
codeSamplesRevisionDigest: sha256:7ae639df01271894474a52b709810943afd11f8d9acde069336e9a1f8588ec56
|
codeSamplesRevisionDigest: sha256:e44fdec134bc5f249b3e785da067ea31d1bba8f9891bca0f6c19d7ace670ab11
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: 1.787.0
|
speakeasyVersion: 1.666.0
|
||||||
sources:
|
sources:
|
||||||
OpenRouter API:
|
OpenRouter API:
|
||||||
inputs:
|
inputs:
|
||||||
@@ -26,9 +33,6 @@ workflow:
|
|||||||
- location: .speakeasy/overlays/open-enums.overlay.yaml
|
- location: .speakeasy/overlays/open-enums.overlay.yaml
|
||||||
- location: .speakeasy/overlays/remove-rss-responses.overlay.yaml
|
- location: .speakeasy/overlays/remove-rss-responses.overlay.yaml
|
||||||
- location: .speakeasy/overlays/add-headers.overlay.yaml
|
- location: .speakeasy/overlays/add-headers.overlay.yaml
|
||||||
- location: .speakeasy/overlays/allof-simplify.overlay.yaml
|
|
||||||
- location: .speakeasy/overlays/boolean-query-params.overlay.yaml
|
|
||||||
- location: .speakeasy/overlays/fix-nullable-pagination.overlay.yaml
|
|
||||||
output: .speakeasy/out.openapi.yaml
|
output: .speakeasy/out.openapi.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
|
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: 1.787.0
|
speakeasyVersion: 1.666.0
|
||||||
sources:
|
sources:
|
||||||
OpenRouter API:
|
OpenRouter API:
|
||||||
inputs:
|
inputs:
|
||||||
@@ -8,10 +8,6 @@ sources:
|
|||||||
- location: .speakeasy/overlays/open-enums.overlay.yaml
|
- location: .speakeasy/overlays/open-enums.overlay.yaml
|
||||||
- location: .speakeasy/overlays/remove-rss-responses.overlay.yaml
|
- location: .speakeasy/overlays/remove-rss-responses.overlay.yaml
|
||||||
- location: .speakeasy/overlays/add-headers.overlay.yaml
|
- location: .speakeasy/overlays/add-headers.overlay.yaml
|
||||||
- location: .speakeasy/overlays/allof-simplify.overlay.yaml
|
|
||||||
- location: .speakeasy/overlays/boolean-query-params.overlay.yaml
|
|
||||||
- location: .speakeasy/overlays/fix-nullable-pagination.overlay.yaml
|
|
||||||
- location: .speakeasy/overlays/retry-transient-status-codes.overlay.yaml
|
|
||||||
output: .speakeasy/out.openapi.yaml
|
output: .speakeasy/out.openapi.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
|
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
# OpenRouter Python SDK
|
# OpenRouter Python SDK
|
||||||
|
|
||||||
The OpenRouter Python SDK is a type-safe toolkit for building AI applications with access to 400+ language models through a unified API.
|
The OpenRouter Python SDK is a type-safe toolkit for building AI applications with access to 300+ language models through a unified API.
|
||||||
|
|
||||||
## Why use the OpenRouter SDK?
|
## Why use the OpenRouter SDK?
|
||||||
|
|
||||||
|
|||||||
+10
-73
@@ -1,6 +1,6 @@
|
|||||||
# OpenRouter SDK
|
# OpenRouter SDK (Beta)
|
||||||
|
|
||||||
The [OpenRouter SDK](https://openrouter.ai/docs/sdks/python) is a Python toolkit designed to help you build AI-powered features and solutions. Giving you easy access to 400+ models across providers in an easy and type-safe way.
|
The [OpenRouter SDK](https://openrouter.ai/docs/sdks/python) is a Python toolkit designed to help you build AI-powered features and solutions. Giving you easy access to over 300 models across providers in an easy and type-safe way.
|
||||||
|
|
||||||
To learn more about how to use the OpenRouter SDK, check out our [API Reference](https://openrouter.ai/docs/sdks/python/reference) and [Documentation](https://openrouter.ai/docs/sdks/python).
|
To learn more about how to use the OpenRouter SDK, check out our [API Reference](https://openrouter.ai/docs/sdks/python/reference) and [Documentation](https://openrouter.ai/docs/sdks/python).
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ It's also possible to write a standalone Python script without needing to set up
|
|||||||
```python
|
```python
|
||||||
#!/usr/bin/env -S uv run --script
|
#!/usr/bin/env -S uv run --script
|
||||||
# /// script
|
# /// script
|
||||||
# requires-python = ">=3.10"
|
# requires-python = ">=3.9"
|
||||||
# dependencies = [
|
# dependencies = [
|
||||||
# "openrouter",
|
# "openrouter",
|
||||||
# ]
|
# ]
|
||||||
@@ -169,69 +169,6 @@ asyncio.run(main())
|
|||||||
|
|
||||||
<!-- No Custom HTTP Client [http-client] -->
|
<!-- No Custom HTTP Client [http-client] -->
|
||||||
|
|
||||||
<!-- Start Pagination [pagination] -->
|
|
||||||
## Pagination
|
|
||||||
|
|
||||||
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
|
|
||||||
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
|
|
||||||
return value of `Next` is `None`, then there are no more pages to be fetched.
|
|
||||||
|
|
||||||
Here's an example of one such pagination call:
|
|
||||||
```python
|
|
||||||
from openrouter import OpenRouter
|
|
||||||
import os
|
|
||||||
|
|
||||||
|
|
||||||
with OpenRouter(
|
|
||||||
http_referer="<value>",
|
|
||||||
x_open_router_title="<value>",
|
|
||||||
x_open_router_categories="<value>",
|
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
|
||||||
) as open_router:
|
|
||||||
|
|
||||||
res = open_router.byok.list(offset=0, limit=50)
|
|
||||||
|
|
||||||
while res is not None:
|
|
||||||
# Handle items
|
|
||||||
|
|
||||||
res = res.next()
|
|
||||||
|
|
||||||
```
|
|
||||||
<!-- End Pagination [pagination] -->
|
|
||||||
|
|
||||||
<!-- Start File uploads [file-upload] -->
|
|
||||||
## File uploads
|
|
||||||
|
|
||||||
Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
|
|
||||||
|
|
||||||
> [!TIP]
|
|
||||||
>
|
|
||||||
> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
|
|
||||||
>
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter import OpenRouter
|
|
||||||
import os
|
|
||||||
|
|
||||||
|
|
||||||
with OpenRouter(
|
|
||||||
http_referer="<value>",
|
|
||||||
x_open_router_title="<value>",
|
|
||||||
x_open_router_categories="<value>",
|
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
|
||||||
) as open_router:
|
|
||||||
|
|
||||||
res = open_router.stt.create_transcription_multipart(file={
|
|
||||||
"file_name": "example.file",
|
|
||||||
"content": open("example.file", "rb"),
|
|
||||||
}, model="openai/whisper-large-v3", language="en")
|
|
||||||
|
|
||||||
# Handle response
|
|
||||||
print(res)
|
|
||||||
|
|
||||||
```
|
|
||||||
<!-- End File uploads [file-upload] -->
|
|
||||||
|
|
||||||
<!-- Start Resource Management [resource-management] -->
|
<!-- Start Resource Management [resource-management] -->
|
||||||
## Resource Management
|
## Resource Management
|
||||||
|
|
||||||
@@ -245,9 +182,6 @@ import os
|
|||||||
def main():
|
def main():
|
||||||
|
|
||||||
with OpenRouter(
|
with OpenRouter(
|
||||||
http_referer="<value>",
|
|
||||||
x_open_router_title="<value>",
|
|
||||||
x_open_router_categories="<value>",
|
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
# Rest of application here...
|
# Rest of application here...
|
||||||
@@ -257,9 +191,6 @@ def main():
|
|||||||
async def amain():
|
async def amain():
|
||||||
|
|
||||||
async with OpenRouter(
|
async with OpenRouter(
|
||||||
http_referer="<value>",
|
|
||||||
x_open_router_title="<value>",
|
|
||||||
x_open_router_categories="<value>",
|
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
# Rest of application here...
|
# Rest of application here...
|
||||||
@@ -309,4 +240,10 @@ To run the test suite, you'll need to set up your environment with an OpenRouter
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
pytest
|
pytest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Maturity
|
||||||
|
|
||||||
|
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
||||||
|
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
||||||
|
looking for the latest version.
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# OpenRouter SDK
|
# OpenRouter SDK (Beta)
|
||||||
|
|
||||||
The [OpenRouter SDK](https://openrouter.ai/docs/sdks/python) is a Python toolkit designed to help you build AI-powered features and solutions. Giving you easy access to 400+ models across providers in an easy and type-safe way.
|
The [OpenRouter SDK](https://openrouter.ai/docs/sdks/python) is a Python toolkit designed to help you build AI-powered features and solutions. Giving you easy access to over 300 models across providers in an easy and type-safe way.
|
||||||
|
|
||||||
To learn more about how to use the OpenRouter SDK, check out our [API Reference](https://openrouter.ai/docs/sdks/python/reference) and [Documentation](https://openrouter.ai/docs/sdks/python).
|
To learn more about how to use the OpenRouter SDK, check out our [API Reference](https://openrouter.ai/docs/sdks/python/reference) and [Documentation](https://openrouter.ai/docs/sdks/python).
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ It's also possible to write a standalone Python script without needing to set up
|
|||||||
```python
|
```python
|
||||||
#!/usr/bin/env -S uv run --script
|
#!/usr/bin/env -S uv run --script
|
||||||
# /// script
|
# /// script
|
||||||
# requires-python = ">=3.10"
|
# requires-python = ">=3.9"
|
||||||
# dependencies = [
|
# dependencies = [
|
||||||
# "openrouter",
|
# "openrouter",
|
||||||
# ]
|
# ]
|
||||||
@@ -169,69 +169,6 @@ asyncio.run(main())
|
|||||||
|
|
||||||
<!-- No Custom HTTP Client [http-client] -->
|
<!-- No Custom HTTP Client [http-client] -->
|
||||||
|
|
||||||
<!-- Start Pagination [pagination] -->
|
|
||||||
## Pagination
|
|
||||||
|
|
||||||
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
|
|
||||||
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
|
|
||||||
return value of `Next` is `None`, then there are no more pages to be fetched.
|
|
||||||
|
|
||||||
Here's an example of one such pagination call:
|
|
||||||
```python
|
|
||||||
from openrouter import OpenRouter
|
|
||||||
import os
|
|
||||||
|
|
||||||
|
|
||||||
with OpenRouter(
|
|
||||||
http_referer="<value>",
|
|
||||||
x_open_router_title="<value>",
|
|
||||||
x_open_router_categories="<value>",
|
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
|
||||||
) as open_router:
|
|
||||||
|
|
||||||
res = open_router.byok.list(offset=0, limit=50)
|
|
||||||
|
|
||||||
while res is not None:
|
|
||||||
# Handle items
|
|
||||||
|
|
||||||
res = res.next()
|
|
||||||
|
|
||||||
```
|
|
||||||
<!-- End Pagination [pagination] -->
|
|
||||||
|
|
||||||
<!-- Start File uploads [file-upload] -->
|
|
||||||
## File uploads
|
|
||||||
|
|
||||||
Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
|
|
||||||
|
|
||||||
> [!TIP]
|
|
||||||
>
|
|
||||||
> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
|
|
||||||
>
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter import OpenRouter
|
|
||||||
import os
|
|
||||||
|
|
||||||
|
|
||||||
with OpenRouter(
|
|
||||||
http_referer="<value>",
|
|
||||||
x_open_router_title="<value>",
|
|
||||||
x_open_router_categories="<value>",
|
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
|
||||||
) as open_router:
|
|
||||||
|
|
||||||
res = open_router.stt.create_transcription_multipart(file={
|
|
||||||
"file_name": "example.file",
|
|
||||||
"content": open("example.file", "rb"),
|
|
||||||
}, model="openai/whisper-large-v3", language="en")
|
|
||||||
|
|
||||||
# Handle response
|
|
||||||
print(res)
|
|
||||||
|
|
||||||
```
|
|
||||||
<!-- End File uploads [file-upload] -->
|
|
||||||
|
|
||||||
<!-- Start Resource Management [resource-management] -->
|
<!-- Start Resource Management [resource-management] -->
|
||||||
## Resource Management
|
## Resource Management
|
||||||
|
|
||||||
@@ -246,8 +183,7 @@ def main():
|
|||||||
|
|
||||||
with OpenRouter(
|
with OpenRouter(
|
||||||
http_referer="<value>",
|
http_referer="<value>",
|
||||||
x_open_router_title="<value>",
|
x_title="<value>",
|
||||||
x_open_router_categories="<value>",
|
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
# Rest of application here...
|
# Rest of application here...
|
||||||
@@ -258,8 +194,7 @@ async def amain():
|
|||||||
|
|
||||||
async with OpenRouter(
|
async with OpenRouter(
|
||||||
http_referer="<value>",
|
http_referer="<value>",
|
||||||
x_open_router_title="<value>",
|
x_title="<value>",
|
||||||
x_open_router_categories="<value>",
|
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
# Rest of application here...
|
# Rest of application here...
|
||||||
@@ -309,4 +244,10 @@ To run the test suite, you'll need to set up your environment with an OpenRouter
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
pytest
|
pytest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Maturity
|
||||||
|
|
||||||
|
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
||||||
|
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
||||||
|
looking for the latest version.
|
||||||
+1
-431
@@ -8,434 +8,4 @@ Based on:
|
|||||||
### Generated
|
### Generated
|
||||||
- [python v0.0.16] .
|
- [python v0.0.16] .
|
||||||
### Releases
|
### Releases
|
||||||
- [PyPI v0.0.16] https://pypi.org/project/openrouter/0.0.16 - .
|
- [PyPI v0.0.16] https://pypi.org/project/openrouter/0.0.16 - .
|
||||||
|
|
||||||
## 2026-06-11 00:55:55
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.9.2] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.9.2] https://pypi.org/project/openrouter/0.9.2 - .
|
|
||||||
|
|
||||||
## 2026-06-17 00:59:07
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.10.0] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.10.0] https://pypi.org/project/openrouter/0.10.0 - .
|
|
||||||
|
|
||||||
## 2026-06-25 21:56:51
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.10.1] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.10.1] https://pypi.org/project/openrouter/0.10.1 - .
|
|
||||||
|
|
||||||
## 2026-06-25 22:28:38
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.10.2] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.10.2] https://pypi.org/project/openrouter/0.10.2 - .
|
|
||||||
|
|
||||||
## 2026-06-26 00:15:50
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.10.3] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.10.3] https://pypi.org/project/openrouter/0.10.3 - .
|
|
||||||
|
|
||||||
## 2026-06-26 12:06:01
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.10.4] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.10.4] https://pypi.org/project/openrouter/0.10.4 - .
|
|
||||||
|
|
||||||
## 2026-06-26 14:36:56
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.10.5] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.10.5] https://pypi.org/project/openrouter/0.10.5 - .
|
|
||||||
|
|
||||||
## 2026-06-26 18:19:11
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.10.6] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.10.6] https://pypi.org/project/openrouter/0.10.6 - .
|
|
||||||
|
|
||||||
## 2026-06-26 23:43:40
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.10.7] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.10.7] https://pypi.org/project/openrouter/0.10.7 - .
|
|
||||||
|
|
||||||
## 2026-06-28 15:27:21
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.10.8] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.10.8] https://pypi.org/project/openrouter/0.10.8 - .
|
|
||||||
|
|
||||||
## 2026-07-01 16:13:11
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.1] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.1] https://pypi.org/project/openrouter/0.11.1 - .
|
|
||||||
|
|
||||||
## 2026-07-03 15:05:16
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.2] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.2] https://pypi.org/project/openrouter/0.11.2 - .
|
|
||||||
|
|
||||||
## 2026-07-03 19:54:08
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.3] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.3] https://pypi.org/project/openrouter/0.11.3 - .
|
|
||||||
|
|
||||||
## 2026-07-07 14:30:37
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.4] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.4] https://pypi.org/project/openrouter/0.11.4 - .
|
|
||||||
|
|
||||||
## 2026-07-07 17:24:44
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.5] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.5] https://pypi.org/project/openrouter/0.11.5 - .
|
|
||||||
|
|
||||||
## 2026-07-07 19:09:09
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.6] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.6] https://pypi.org/project/openrouter/0.11.6 - .
|
|
||||||
|
|
||||||
## 2026-07-07 21:46:35
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.7] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.7] https://pypi.org/project/openrouter/0.11.7 - .
|
|
||||||
|
|
||||||
## 2026-07-08 03:29:04
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.8] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.8] https://pypi.org/project/openrouter/0.11.8 - .
|
|
||||||
|
|
||||||
## 2026-07-08 07:00:39
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.9] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.9] https://pypi.org/project/openrouter/0.11.9 - .
|
|
||||||
|
|
||||||
## 2026-07-08 09:31:18
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.10] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.10] https://pypi.org/project/openrouter/0.11.10 - .
|
|
||||||
|
|
||||||
## 2026-07-08 19:07:22
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.11] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.11] https://pypi.org/project/openrouter/0.11.11 - .
|
|
||||||
|
|
||||||
## 2026-07-09 10:13:53
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.12] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.12] https://pypi.org/project/openrouter/0.11.12 - .
|
|
||||||
|
|
||||||
## 2026-07-09 17:12:18
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.13] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.13] https://pypi.org/project/openrouter/0.11.13 - .
|
|
||||||
|
|
||||||
## 2026-07-09 17:28:34
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.14] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.14] https://pypi.org/project/openrouter/0.11.14 - .
|
|
||||||
|
|
||||||
## 2026-07-09 18:16:05
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.15] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.15] https://pypi.org/project/openrouter/0.11.15 - .
|
|
||||||
|
|
||||||
## 2026-07-09 19:48:43
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.16] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.16] https://pypi.org/project/openrouter/0.11.16 - .
|
|
||||||
|
|
||||||
## 2026-07-09 21:34:56
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.17] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.17] https://pypi.org/project/openrouter/0.11.17 - .
|
|
||||||
|
|
||||||
## 2026-07-10 01:18:52
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.18] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.18] https://pypi.org/project/openrouter/0.11.18 - .
|
|
||||||
|
|
||||||
## 2026-07-10 15:41:48
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.19] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.19] https://pypi.org/project/openrouter/0.11.19 - .
|
|
||||||
|
|
||||||
## 2026-07-10 20:14:59
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.20] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.20] https://pypi.org/project/openrouter/0.11.20 - .
|
|
||||||
|
|
||||||
## 2026-07-10 23:01:43
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.21] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.21] https://pypi.org/project/openrouter/0.11.21 - .
|
|
||||||
|
|
||||||
## 2026-07-11 03:19:26
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.22] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.22] https://pypi.org/project/openrouter/0.11.22 - .
|
|
||||||
|
|
||||||
## 2026-07-12 16:36:57
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.23] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.23] https://pypi.org/project/openrouter/0.11.23 - .
|
|
||||||
|
|
||||||
## 2026-07-13 17:54:57
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.24] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.24] https://pypi.org/project/openrouter/0.11.24 - .
|
|
||||||
|
|
||||||
## 2026-07-13 19:18:28
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.25] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.25] https://pypi.org/project/openrouter/0.11.25 - .
|
|
||||||
|
|
||||||
## 2026-07-13 19:27:34
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.26] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.26] https://pypi.org/project/openrouter/0.11.26 - .
|
|
||||||
|
|
||||||
## 2026-07-13 20:42:45
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.27] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.27] https://pypi.org/project/openrouter/0.11.27 - .
|
|
||||||
|
|
||||||
## 2026-07-14 05:35:17
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.28] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.28] https://pypi.org/project/openrouter/0.11.28 - .
|
|
||||||
|
|
||||||
## 2026-07-14 14:49:30
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.29] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.29] https://pypi.org/project/openrouter/0.11.29 - .
|
|
||||||
|
|
||||||
## 2026-07-14 17:49:24
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.30] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.30] https://pypi.org/project/openrouter/0.11.30 - .
|
|
||||||
|
|
||||||
## 2026-07-14 21:03:59
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.31] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.31] https://pypi.org/project/openrouter/0.11.31 - .
|
|
||||||
|
|
||||||
## 2026-07-14 21:26:36
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.32] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.32] https://pypi.org/project/openrouter/0.11.32 - .
|
|
||||||
|
|
||||||
## 2026-07-14 22:07:41
|
|
||||||
### Changes
|
|
||||||
Based on:
|
|
||||||
- OpenAPI Doc
|
|
||||||
- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy
|
|
||||||
### Generated
|
|
||||||
- [python v0.11.33] .
|
|
||||||
### Releases
|
|
||||||
- [PyPI v0.11.33] https://pypi.org/project/openrouter/0.11.33 - .
|
|
||||||
@@ -7,15 +7,16 @@ import os
|
|||||||
|
|
||||||
with OpenRouter(
|
with OpenRouter(
|
||||||
http_referer="<value>",
|
http_referer="<value>",
|
||||||
x_open_router_title="<value>",
|
x_title="<value>",
|
||||||
x_open_router_categories="<value>",
|
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
|
|
||||||
res = open_router.analytics.get_user_activity()
|
res = open_router.beta.responses.send(service_tier="auto", stream=False)
|
||||||
|
|
||||||
# Handle response
|
with res as event_stream:
|
||||||
print(res)
|
for event in event_stream:
|
||||||
|
# handle event
|
||||||
|
print(event, flush=True)
|
||||||
```
|
```
|
||||||
|
|
||||||
</br>
|
</br>
|
||||||
@@ -32,15 +33,16 @@ async def main():
|
|||||||
|
|
||||||
async with OpenRouter(
|
async with OpenRouter(
|
||||||
http_referer="<value>",
|
http_referer="<value>",
|
||||||
x_open_router_title="<value>",
|
x_title="<value>",
|
||||||
x_open_router_categories="<value>",
|
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
|
|
||||||
res = await open_router.analytics.get_user_activity_async()
|
res = await open_router.beta.responses.send_async(service_tier="auto", stream=False)
|
||||||
|
|
||||||
# Handle response
|
async with res as event_stream:
|
||||||
print(res)
|
async for event in event_stream:
|
||||||
|
# handle event
|
||||||
|
print(event, flush=True)
|
||||||
|
|
||||||
asyncio.run(main())
|
asyncio.run(main())
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AABenchmarkEntry"
|
|
||||||
---
|
|
||||||
|
|
||||||
Artificial Analysis benchmark index scores.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
|
||||||
| `agentic_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Agentic Index score | 55.8 |
|
|
||||||
| `coding_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Coding Index score | 63.2 |
|
|
||||||
| `intelligence_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Intelligence Index score | 71.4 |
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Action"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.OutputWebSearchCallItemActionSearch`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.OutputWebSearchCallItemActionSearch = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ActionOpenPage`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ActionOpenPage = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ActionFindInPage`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ActionFindInPage = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
---
|
|
||||||
title: "ActionEnum"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import ActionEnum
|
|
||||||
|
|
||||||
# Open enum: unrecognized values are captured as UnrecognizedStr
|
|
||||||
value: ActionEnum = "read"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will not fail type checks.
|
|
||||||
|
|
||||||
- `"read"`
|
|
||||||
- `"write"`
|
|
||||||
- `"delete"`
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
---
|
|
||||||
title: "ActionFindInPage"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
|
||||||
| `pattern` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `type` | [components.TypeFindInPage](../components/typefindinpage.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
| `url` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "ActionOpenPage"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
|
||||||
| `type` | [components.TypeOpenPage](../components/typeopenpage.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "ActionTypeSearch"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import ActionTypeSearch
|
|
||||||
value: ActionTypeSearch = "search"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"search"`
|
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# ActivityItem
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
|
| `date_` | *str* | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 |
|
||||||
|
| `model` | *str* | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 |
|
||||||
|
| `model_permaslug` | *str* | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 |
|
||||||
|
| `endpoint_id` | *str* | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 |
|
||||||
|
| `provider_name` | *str* | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI |
|
||||||
|
| `usage` | *float* | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 |
|
||||||
|
| `byok_usage_inference` | *float* | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 |
|
||||||
|
| `requests` | *float* | :heavy_check_mark: | Number of requests made | 5 |
|
||||||
|
| `prompt_tokens` | *float* | :heavy_check_mark: | Total prompt tokens used | 50 |
|
||||||
|
| `completion_tokens` | *float* | :heavy_check_mark: | Total completion tokens generated | 125 |
|
||||||
|
| `reasoning_tokens` | *float* | :heavy_check_mark: | Total reasoning tokens used | 25 |
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
title: "ActivityItem"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
|
||||||
| `byok_usage_inference` | *float* | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 |
|
|
||||||
| `completion_tokens` | *int* | :heavy_check_mark: | Total completion tokens generated | 125 |
|
|
||||||
| `date_` | *str* | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 |
|
|
||||||
| `endpoint_id` | *str* | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 |
|
|
||||||
| `model` | *str* | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 |
|
|
||||||
| `model_permaslug` | *str* | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 |
|
|
||||||
| `prompt_tokens` | *int* | :heavy_check_mark: | Total prompt tokens used | 50 |
|
|
||||||
| `provider_name` | *str* | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI |
|
|
||||||
| `reasoning_tokens` | *int* | :heavy_check_mark: | Total reasoning tokens used | 25 |
|
|
||||||
| `requests` | *int* | :heavy_check_mark: | Number of requests made | 5 |
|
|
||||||
| `usage` | *float* | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
---
|
|
||||||
title: "ActivityResponse"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
||||||
| `data` | List[[components.ActivityItem](../components/activityitem.mdx)] | :heavy_check_mark: | List of activity items |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdditionalToolsItem"
|
|
||||||
---
|
|
||||||
|
|
||||||
Additional tools made available to the model at this point in the input
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
||||||
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `role` | [components.AdditionalToolsItemRole](../components/additionaltoolsitemrole.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
| `tools` | List[[components.AdditionalToolsItemToolUnion](../components/additionaltoolsitemtoolunion.mdx)] | :heavy_check_mark: | N/A |
|
|
||||||
| `type` | [components.TypeAdditionalTools](../components/typeadditionaltools.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdditionalToolsItemRole"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AdditionalToolsItemRole
|
|
||||||
|
|
||||||
# Open enum: unrecognized values are captured as UnrecognizedStr
|
|
||||||
value: AdditionalToolsItemRole = "unknown"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will not fail type checks.
|
|
||||||
|
|
||||||
- `"unknown"`
|
|
||||||
- `"user"`
|
|
||||||
- `"assistant"`
|
|
||||||
- `"system"`
|
|
||||||
- `"critic"`
|
|
||||||
- `"discriminator"`
|
|
||||||
- `"developer"`
|
|
||||||
- `"tool"`
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdditionalToolsItemTool"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
|
|
||||||
| `type` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `__pydantic_extra__` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdditionalToolsItemToolFunction"
|
|
||||||
---
|
|
||||||
|
|
||||||
Function tool definition
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
||||||
| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `name` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `parameters` | Dict[str, *Nullable[Any]*] | :heavy_check_mark: | N/A |
|
|
||||||
| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `type` | [components.AdditionalToolsItemTypeFunction](../components/additionaltoolsitemtypefunction.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,168 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdditionalToolsItemToolUnion"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.AdditionalToolsItemToolFunction`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AdditionalToolsItemToolFunction = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.PreviewWebSearchServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.PreviewWebSearchServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.Preview20250311WebSearchServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.Preview20250311WebSearchServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.LegacyWebSearchServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.LegacyWebSearchServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.WebSearchServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.WebSearchServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.FileSearchServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.FileSearchServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ComputerUseServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ComputerUseServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.CodeInterpreterServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.CodeInterpreterServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.McpServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.McpServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ImageGenerationServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ImageGenerationServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.CodexLocalShellTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.CodexLocalShellTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ShellServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ShellServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ApplyPatchServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ApplyPatchServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.CustomTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.CustomTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.AdvisorServerToolOpenRouter`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AdvisorServerToolOpenRouter = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.SubagentServerToolOpenRouter`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.SubagentServerToolOpenRouter = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.DatetimeServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.DatetimeServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.FilesServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.FilesServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.FusionServerToolOpenRouter`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.FusionServerToolOpenRouter = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ImageGenerationServerToolOpenRouter`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ImageGenerationServerToolOpenRouter = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.SearchModelsServerToolOpenRouter`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.SearchModelsServerToolOpenRouter = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.WebFetchServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.WebFetchServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.WebSearchServerToolOpenRouter`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.WebSearchServerToolOpenRouter = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ApplyPatchServerToolOpenRouter`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ApplyPatchServerToolOpenRouter = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.BashServerTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.BashServerTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ShellServerToolOpenRouter`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ShellServerToolOpenRouter = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.AdditionalToolsItemTool`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AdditionalToolsItemTool = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdditionalToolsItemTypeFunction"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AdditionalToolsItemTypeFunction
|
|
||||||
value: AdditionalToolsItemTypeFunction = "function"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"function"`
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdvisorNestedTool"
|
|
||||||
---
|
|
||||||
|
|
||||||
A tool made available to the advisor sub-agent. Only OpenRouter server tools (e.g. openrouter:web_search) are supported; function tools are rejected because the advisor has no way to execute them. The advisor tool may not list itself.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
|
||||||
| `parameters` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | |
|
|
||||||
| `type` | *str* | :heavy_check_mark: | N/A | |
|
|
||||||
| `__pydantic_extra__` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \{<br/>"type": "openrouter:web_search"<br/>} |
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdvisorReasoning"
|
|
||||||
---
|
|
||||||
|
|
||||||
Reasoning configuration forwarded to the advisor call. Use this to control reasoning effort and token budget for models that support extended thinking.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `effort` | [Optional[components.AdvisorReasoningEffort]](../components/advisorreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the advisor call. |
|
|
||||||
| `max_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum number of reasoning tokens the advisor may use. |
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdvisorReasoningEffort"
|
|
||||||
---
|
|
||||||
|
|
||||||
Reasoning effort level for the advisor call.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AdvisorReasoningEffort
|
|
||||||
|
|
||||||
# Open enum: unrecognized values are captured as UnrecognizedStr
|
|
||||||
value: AdvisorReasoningEffort = "max"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will not fail type checks.
|
|
||||||
|
|
||||||
- `"max"`
|
|
||||||
- `"xhigh"`
|
|
||||||
- `"high"`
|
|
||||||
- `"medium"`
|
|
||||||
- `"low"`
|
|
||||||
- `"minimal"`
|
|
||||||
- `"none"`
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdvisorServerToolConfig"
|
|
||||||
---
|
|
||||||
|
|
||||||
Configuration for one openrouter:advisor server tool entry.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `forward_transcript` | *Optional[bool]* | :heavy_minus_sign: | When true, the full parent conversation is forwarded to the advisor so it sees the same context the executor does (and the tool-call `prompt`, if given, is appended as a final user turn). When false or omitted, the advisor receives only the `prompt` the executor passes in the tool call. | false |
|
|
||||||
| `instructions` | *Optional[str]* | :heavy_minus_sign: | System instructions for the advisor sub-agent. When omitted, the advisor responds with no system prompt of its own. | You are a senior staff engineer. Give a focused, decisive plan. |
|
|
||||||
| `max_completion_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum number of output tokens (including reasoning) the advisor may produce. When omitted, the provider's default applies. | 2048 |
|
|
||||||
| `max_tool_calls` | *Optional[int]* | :heavy_minus_sign: | Maximum number of tool-calling steps the advisor sub-agent may take during its agentic loop. Capped at 25. Only relevant when the advisor is given tools. | 5 |
|
|
||||||
| `model` | *Optional[str]* | :heavy_minus_sign: | Slug of the advisor model to consult (any OpenRouter model). When omitted, the executor can choose it via the tool call's `model` argument; if neither is set, the model from the outer API request is used. The advisor tool itself cannot be the advisor model. | ~anthropic/claude-opus-latest |
|
|
||||||
| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for this advisor. The model sees one tool per named advisor (and one default for an unnamed entry). Names must be unique across advisor entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | reviewer |
|
|
||||||
| `reasoning` | [Optional[components.AdvisorReasoning]](../components/advisorreasoning.mdx) | :heavy_minus_sign: | Reasoning configuration forwarded to the advisor call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{<br/>"effort": "high"<br/>} |
|
|
||||||
| `stream` | *Optional[bool]* | :heavy_minus_sign: | When true, the advisor's advice streams incrementally as it is produced. In the Responses API this emits `response.output_text.delta` events targeting the advisor output item; the final `advice` field is still set on the completed item. Has no effect on the Chat Completions API (where the advice arrives only as the final tool result). When false or omitted, the advice arrives only as the final result. | false |
|
|
||||||
| `temperature` | *Optional[float]* | :heavy_minus_sign: | Sampling temperature forwarded to the advisor call. When omitted, the provider's default applies. | 0.7 |
|
|
||||||
| `tools` | List[[components.AdvisorNestedTool](../components/advisornestedtool.mdx)] | :heavy_minus_sign: | Tools the advisor sub-agent may use while forming its advice. The advisor runs as an agentic sub-agent over these tools, then returns its text. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the advisor tool itself. | |
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdvisorServerToolOpenRouter"
|
|
||||||
---
|
|
||||||
|
|
||||||
OpenRouter built-in server tool: consults a higher-intelligence advisor model (any OpenRouter model) for guidance mid-generation and returns its response. The advisor may run as a sub-agent with its own tools. Include multiple entries to offer several named advisors; at most one entry may omit `name` to act as the default advisor.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
||||||
| `parameters` | [Optional[components.AdvisorServerToolConfig]](../components/advisorservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:advisor server tool entry. | \{<br/>"model": "~anthropic/claude-opus-latest",<br/>"name": "reviewer"<br/>} |
|
|
||||||
| `type` | [components.AdvisorServerToolOpenRouterType](../components/advisorservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AdvisorServerToolOpenRouterType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AdvisorServerToolOpenRouterType
|
|
||||||
value: AdvisorServerToolOpenRouterType = "openrouter:advisor"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"openrouter:advisor"`
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Agent"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
|
|
||||||
| `agent_name` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `__pydantic_extra__` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AgentMessageItem"
|
|
||||||
---
|
|
||||||
|
|
||||||
A message routed between agents in a multi-agent session
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `agent` | [OptionalNullable[components.Agent]](../components/agent.mdx) | :heavy_minus_sign: | N/A | |
|
|
||||||
| `author` | *str* | :heavy_check_mark: | N/A | |
|
|
||||||
| `content` | List[[components.AgentMessageItemContentUnion](../components/agentmessageitemcontentunion.mdx)] | :heavy_check_mark: | N/A | |
|
|
||||||
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `recipient` | *str* | :heavy_check_mark: | N/A | |
|
|
||||||
| `type` | [components.TypeAgentMessage](../components/typeagentmessage.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
| `__pydantic_extra__` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \{<br/>"author": "/root/worker",<br/>"content": [<br/>\{<br/>"text": "Task complete.",<br/>"type": "input_text"<br/>}<br/>],<br/>"recipient": "/root",<br/>"type": "agent_message"<br/>} |
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AgentMessageItemContentInputImage"
|
|
||||||
---
|
|
||||||
|
|
||||||
Image input content item
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
||||||
| `detail` | [components.AgentMessageItemDetail](../components/agentmessageitemdetail.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `type` | [components.AgentMessageItemTypeInputImage](../components/agentmessageitemtypeinputimage.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AgentMessageItemContentUnion"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.InputText`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.InputText = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.AgentMessageItemContentInputImage`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AgentMessageItemContentInputImage = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ContentEncryptedContent`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ContentEncryptedContent = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AgentMessageItemDetail"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AgentMessageItemDetail
|
|
||||||
|
|
||||||
# Open enum: unrecognized values are captured as UnrecognizedStr
|
|
||||||
value: AgentMessageItemDetail = "auto"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will not fail type checks.
|
|
||||||
|
|
||||||
- `"auto"`
|
|
||||||
- `"high"`
|
|
||||||
- `"low"`
|
|
||||||
- `"original"`
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AgentMessageItemTypeInputImage"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AgentMessageItemTypeInputImage
|
|
||||||
value: AgentMessageItemTypeInputImage = "input_image"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"input_image"`
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AllowedTools"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AllowedToolsUnion"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `List[str]`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: List[str] = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.AllowedTools`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AllowedTools = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `Any`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: Any = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Always"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnnotationAddedEvent"
|
|
||||||
---
|
|
||||||
|
|
||||||
Event emitted when a text annotation is added to output
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
||||||
| `annotation` | [components.OpenAIResponsesAnnotation](../components/openairesponsesannotation.mdx) | :heavy_check_mark: | N/A | \{<br/>"file_id": "file-abc123",<br/>"filename": "research_paper.pdf",<br/>"index": 0,<br/>"type": "file_citation"<br/>} |
|
|
||||||
| `annotation_index` | *int* | :heavy_check_mark: | N/A | |
|
|
||||||
| `content_index` | *int* | :heavy_check_mark: | N/A | |
|
|
||||||
| `item_id` | *str* | :heavy_check_mark: | N/A | |
|
|
||||||
| `output_index` | *int* | :heavy_check_mark: | N/A | |
|
|
||||||
| `sequence_number` | *int* | :heavy_check_mark: | N/A | |
|
|
||||||
| `type` | [components.AnnotationAddedEventType](../components/annotationaddedeventtype.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnnotationAddedEventType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnnotationAddedEventType
|
|
||||||
value: AnnotationAddedEventType = "response.output_text.annotation.added"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"response.output_text.annotation.added"`
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicAdvisorMessageUsageIteration"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{<br/>"ephemeral_1h_input_tokens": 0,<br/>"ephemeral_5m_input_tokens": 0<br/>} |
|
|
||||||
| `cache_creation_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `cache_read_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `model` | *str* | :heavy_check_mark: | N/A | |
|
|
||||||
| `type` | [components.AnthropicAdvisorMessageUsageIterationType](../components/anthropicadvisormessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicAdvisorMessageUsageIterationType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicAdvisorMessageUsageIterationType
|
|
||||||
value: AnthropicAdvisorMessageUsageIterationType = "advisor_message"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"advisor_message"`
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicAllowedCallers"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicAllowedCallers
|
|
||||||
|
|
||||||
# Open enum: unrecognized values are captured as UnrecognizedStr
|
|
||||||
value: AnthropicAllowedCallers = "direct"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will not fail type checks.
|
|
||||||
|
|
||||||
- `"direct"`
|
|
||||||
- `"code_execution_20250825"`
|
|
||||||
- `"code_execution_20260120"`
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicBase64ImageSource"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
||||||
| `data` | *str* | :heavy_check_mark: | N/A | |
|
|
||||||
| `media_type` | [components.AnthropicImageMimeType](../components/anthropicimagemimetype.mdx) | :heavy_check_mark: | N/A | image/jpeg |
|
|
||||||
| `type` | [components.AnthropicBase64ImageSourceType](../components/anthropicbase64imagesourcetype.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicBase64ImageSourceType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicBase64ImageSourceType
|
|
||||||
value: AnthropicBase64ImageSourceType = "base64"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"base64"`
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicBase64PdfSource"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
||||||
| `data` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `media_type` | [components.AnthropicBase64PdfSourceMediaType](../components/anthropicbase64pdfsourcemediatype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
| `type` | [components.AnthropicBase64PdfSourceType](../components/anthropicbase64pdfsourcetype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicBase64PdfSourceMediaType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicBase64PdfSourceMediaType
|
|
||||||
value: AnthropicBase64PdfSourceMediaType = "application/pdf"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"application/pdf"`
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicBase64PdfSourceType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicBase64PdfSourceType
|
|
||||||
value: AnthropicBase64PdfSourceType = "base64"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"base64"`
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCacheControlDirective"
|
|
||||||
---
|
|
||||||
|
|
||||||
Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
||||||
| `ttl` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m |
|
|
||||||
| `type` | [components.AnthropicCacheControlDirectiveType](../components/anthropiccachecontroldirectivetype.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCacheControlDirectiveType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicCacheControlDirectiveType
|
|
||||||
value: AnthropicCacheControlDirectiveType = "ephemeral"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"ephemeral"`
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCacheControlTTL"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicCacheControlTTL
|
|
||||||
|
|
||||||
# Open enum: unrecognized values are captured as UnrecognizedStr
|
|
||||||
value: AnthropicCacheControlTTL = "5m"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will not fail type checks.
|
|
||||||
|
|
||||||
- `"5m"`
|
|
||||||
- `"1h"`
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCacheCreation"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
|
||||||
| `ephemeral_1h_input_tokens` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `ephemeral_5m_input_tokens` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCitationCharLocationParam"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `cited_text` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `document_index` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A |
|
|
||||||
| `end_char_index` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `start_char_index` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `type` | [components.AnthropicCitationCharLocationParamType](../components/anthropiccitationcharlocationparamtype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCitationCharLocationParamType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicCitationCharLocationParamType
|
|
||||||
value: AnthropicCitationCharLocationParamType = "char_location"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"char_location"`
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCitationContentBlockLocationParam"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `cited_text` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `document_index` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A |
|
|
||||||
| `end_block_index` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `start_block_index` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `type` | [components.AnthropicCitationContentBlockLocationParamType](../components/anthropiccitationcontentblocklocationparamtype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCitationContentBlockLocationParamType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicCitationContentBlockLocationParamType
|
|
||||||
value: AnthropicCitationContentBlockLocationParamType = "content_block_location"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"content_block_location"`
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCitationPageLocationParam"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `cited_text` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `document_index` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A |
|
|
||||||
| `end_page_number` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `start_page_number` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `type` | [components.AnthropicCitationPageLocationParamType](../components/anthropiccitationpagelocationparamtype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCitationPageLocationParamType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicCitationPageLocationParamType
|
|
||||||
value: AnthropicCitationPageLocationParamType = "page_location"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"page_location"`
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCitationSearchResultLocationParam"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `cited_text` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `end_block_index` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `search_result_index` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `source` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `start_block_index` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
| `title` | *Nullable[str]* | :heavy_check_mark: | N/A |
|
|
||||||
| `type` | [components.AnthropicCitationSearchResultLocationParamType](../components/anthropiccitationsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCitationSearchResultLocationParamType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicCitationSearchResultLocationParamType
|
|
||||||
value: AnthropicCitationSearchResultLocationParamType = "search_result_location"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"search_result_location"`
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCitationWebSearchResultLocationParam"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `cited_text` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `encrypted_index` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `title` | *Nullable[str]* | :heavy_check_mark: | N/A |
|
|
||||||
| `type` | [components.AnthropicCitationWebSearchResultLocationParamType](../components/anthropiccitationwebsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
| `url` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCitationWebSearchResultLocationParamType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicCitationWebSearchResultLocationParamType
|
|
||||||
value: AnthropicCitationWebSearchResultLocationParamType = "web_search_result_location"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"web_search_result_location"`
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCompactionUsageIteration"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{<br/>"ephemeral_1h_input_tokens": 0,<br/>"ephemeral_5m_input_tokens": 0<br/>} |
|
|
||||||
| `cache_creation_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `cache_read_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `type` | [components.AnthropicCompactionUsageIterationType](../components/anthropiccompactionusageiterationtype.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicCompactionUsageIterationType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicCompactionUsageIterationType
|
|
||||||
value: AnthropicCompactionUsageIterationType = "compaction"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"compaction"`
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicDocumentBlockParam"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{<br/>"type": "ephemeral"<br/>} |
|
|
||||||
| `citations` | [OptionalNullable[components.AnthropicDocumentBlockParamCitations]](../components/anthropicdocumentblockparamcitations.mdx) | :heavy_minus_sign: | N/A | |
|
|
||||||
| `context` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `source` | [components.AnthropicDocumentBlockParamSourceUnion](../components/anthropicdocumentblockparamsourceunion.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `type` | [components.TypeDocument](../components/typedocument.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicDocumentBlockParamCitations"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicDocumentBlockParamContent1"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.AnthropicImageBlockParam`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AnthropicImageBlockParam = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.AnthropicTextBlockParam`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AnthropicTextBlockParam = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicDocumentBlockParamContent2"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `str`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: str = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `List[components.AnthropicDocumentBlockParamContent1]`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: List[components.AnthropicDocumentBlockParamContent1] = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicDocumentBlockParamSourceUnion"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.AnthropicBase64PdfSource`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AnthropicBase64PdfSource = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.AnthropicPlainTextSource`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AnthropicPlainTextSource = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.SourceContent`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.SourceContent = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.AnthropicURLPdfSource`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AnthropicURLPdfSource = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.AnthropicFileDocumentSource`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AnthropicFileDocumentSource = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicFileDocumentSource"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
||||||
| `file_id` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `type` | [components.AnthropicFileDocumentSourceType](../components/anthropicfiledocumentsourcetype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicFileDocumentSourceType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicFileDocumentSourceType
|
|
||||||
value: AnthropicFileDocumentSourceType = "file"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"file"`
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicImageBlockParam"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{<br/>"type": "ephemeral"<br/>} |
|
|
||||||
| `source` | [components.AnthropicImageBlockParamSource](../components/anthropicimageblockparamsource.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
| `type` | [components.AnthropicImageBlockParamType](../components/anthropicimageblockparamtype.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicImageBlockParamSource"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.AnthropicBase64ImageSource`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AnthropicBase64ImageSource = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.AnthropicURLImageSource`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AnthropicURLImageSource = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicImageBlockParamType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicImageBlockParamType
|
|
||||||
value: AnthropicImageBlockParamType = "image"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"image"`
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicImageMimeType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicImageMimeType
|
|
||||||
|
|
||||||
# Open enum: unrecognized values are captured as UnrecognizedStr
|
|
||||||
value: AnthropicImageMimeType = "image/jpeg"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will not fail type checks.
|
|
||||||
|
|
||||||
- `"image/jpeg"`
|
|
||||||
- `"image/png"`
|
|
||||||
- `"image/gif"`
|
|
||||||
- `"image/webp"`
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicInputTokensClearAtLeast"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `type` | [components.AnthropicInputTokensClearAtLeastType](../components/anthropicinputtokensclearatleasttype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
| `value` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicInputTokensClearAtLeastType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicInputTokensClearAtLeastType
|
|
||||||
value: AnthropicInputTokensClearAtLeastType = "input_tokens"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"input_tokens"`
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicInputTokensTrigger"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
||||||
| `type` | [components.AnthropicInputTokensTriggerType](../components/anthropicinputtokenstriggertype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
| `value` | *int* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicInputTokensTriggerType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicInputTokensTriggerType
|
|
||||||
value: AnthropicInputTokensTriggerType = "input_tokens"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"input_tokens"`
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicIterationCacheCreation"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
|
||||||
| `ephemeral_1h_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `ephemeral_5m_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicMessageUsageIteration"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{<br/>"ephemeral_1h_input_tokens": 0,<br/>"ephemeral_5m_input_tokens": 0<br/>} |
|
|
||||||
| `cache_creation_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `cache_read_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `type` | [components.AnthropicMessageUsageIterationType](../components/anthropicmessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicMessageUsageIterationType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicMessageUsageIterationType
|
|
||||||
value: AnthropicMessageUsageIterationType = "message"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"message"`
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicPlainTextSource"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
||||||
| `data` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `media_type` | [components.AnthropicPlainTextSourceMediaType](../components/anthropicplaintextsourcemediatype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
| `type` | [components.AnthropicPlainTextSourceType](../components/anthropicplaintextsourcetype.mdx) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicPlainTextSourceMediaType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicPlainTextSourceMediaType
|
|
||||||
value: AnthropicPlainTextSourceMediaType = "text/plain"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"text/plain"`
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "AnthropicPlainTextSourceType"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openrouter.components import AnthropicPlainTextSourceType
|
|
||||||
value: AnthropicPlainTextSourceType = "text"
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
- `"text"`
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user