ApiKeyCredentialProvider — Methods — TypeScript SDK API reference — QVeris

Connect your AI

Bring professional data to the AI you already use.
Find supported data services, choose a connection method, and use them in the tools where you already work.

Connect your AI Find the data you need

Connect Your AI

Agent Plugins
Hosted MCP
CLI
API & SDKs

Data & Tools

Models
Data & Tools
Finance Data Coverage

Demos & Examples

Playground
QVeris Lab
Earnings Copilot (opens in a new tab)
Options Assistant (opens in a new tab)
View all applications

Developers

Guides
API Reference
Python SDK
JavaScript SDK
MCP Server
Model Gateway
Blog
CLI Reference

Open Source & Partners

Ecosystem Overview
Agent Skills
QVeris on GitHub (opens in a new tab)
QVeris on npm (opens in a new tab)
QVeris on ClawHub (opens in a new tab)
Agent Guide

Company

Service status
Pricing
What's New
Help Center
Security
Terms
Privacy

© 2026 QVeris AI, LLC. All rights reserved.

X / Twitter LinkedIn GitHub

Start Here

Getting Started Recipes

Integration Paths

CLI Python SDK Python SDK API Reference TypeScript SDK TypeScript SDK API Reference MCP Server Model Gateway REST API Reference

Environment Setup

Editor & CLI Setup OpenClaw Setup Codex & ChatGPT Desktop Setup Claude Code Setup OpenCode Setup

REST operations

POST Discover capabilities POST Inspect capabilities POST Probe a capability POST Call a capability GET Reconcile an uncertain Call GET Get capability details POST Query a capability POST Register an anonymous agent trial POST Claim an anonymous agent trial POST Verify an agent trial claim POST Prepare an Agent trial POST Activate an Agent trial GET Read Agent trial state DELETE End an Agent trial GET Read trial execution readiness POST Quote a trial Call POST Confirm a trial Call GET Recover a trial Call GET Recover a trial claim receipt POST Verify a new trial owner POST Save a trial to a new account POST Save a trial to an existing account POST Start device authorization POST Issue or exchange an OAuth token POST Introspect a resource token POST Revoke an OAuth token GET Query OAuth usage history GET Query OAuth credits ledger POST Verify an API token GET Get authenticated credits GET Get current credits GET Get settlement history GET Get credits spent GET Query usage history GET Summarize usage history GET Export usage history GET Get a usage event GET Query the credits ledger GET Get ledger readiness GET Export the credits ledger GET Get a ledger entry GET Get API metadata GET List providers GET List provider categories

Python API reference

Client close discover search_tools inspect get_tools_by_ids probe call reconcile_call execute_tool capability_detail capability_query usage ledger handle_tool_call Agent Configuration Response models CapabilityDetailResponse CapabilityQueryRequest CapabilityQueryResponse CatalogVerification CreditsLedgerItem CreditsLedgerResponse ExecutionRestrictions Message ProbeQuoteResult ProbeRecoveryAdvice ProbeSchemaResult ProbeSchemaViolation ProbeUnknownResult PublicSearchResponse RegionRestrictions SearchResponse StreamEvent ToolCapability ToolCapabilityTag ToolCategory ToolExecutionResponse ToolInfo ToolParameter ToolProbeResponse UsageEventItem UsageHistoryResponse ValidationIssue VerificationCheck ZeroQuoteSettlementReview

TypeScript API reference

AgentDelegationCredentialProvider AgentDelegationCredentialProvider — Methods AgentDelegationError AgentDelegationError — Methods ApiKeyCredentialProvider ApiKeyCredentialProvider — Methods Qveris Qveris — Methods QverisApiError QverisApiError — Methods AgentDelegationConstraints AgentDelegationCredentialProviderOptions ApiEnvelope ApiError ApiObservability BillingChargeLine BillingPrice BillingRule CallOptions CapabilityDetailResponse CapabilityQueryResponse CatalogCapability CatalogCapabilityName CatalogVerification CompactBillingStatement CredentialContext CredentialProvider CredentialProvider — Methods CreditsLedgerItem CreditsLedgerRequest CreditsLedgerResponse CreditsResponse DiscoverOptions ExecuteRequest ExecuteResponse ExecuteResultData ExecuteResultFields ExecuteResultProjectedOverflow ExecuteResultRawObject ExecuteResultSummaryBase ExecuteResultTruncated ExecuteTransportOptions ExecutionLookupResponse ExecutionRestrictions GetToolsByIdsRequest InspectOptions NextAction ProbeOptions ProbeQuoteResult ProbeRecoveryAdvice ProbeRequest ProbeResponse ProbeSchemaResult ProbeSchemaViolation ProbeUnknownResult PublicDiscoveryClient PublicDiscoveryClient — Methods PublicInspectOptions QverisAdapterOptions QverisAdapterTool QverisClientConfig RegionRestrictions SearchRequest SearchResponse SearchStats ToolCapability ToolCapabilityTag ToolCategory ToolExamples ToolExecutionReconciliationData ToolInfo ToolParameter ToolStats UsageEventItem UsageEventsResponse UsageHistoryRequest ValidationIssue VerificationCheck ZeroQuoteSettlementReview AgentDelegationErrorCode ApiErrorType ApiOperation CapabilityQueryRequest CredentialPurpose ExecuteResult ExecuteResultSummary JsonValue ProbeCheck ProbeLiveBudget PublicDiscoverOptions PublicDiscoveryClientOptions PublicDiscoveryContext PublicSearchResponse PublicToolInfo QverisClientOptions QverisDefaultTools QverisProbeTools ToolParameterContract VerificationCheckName VerificationStatus getQverisTools()

Resources

GitHub Repository ↗npm Packages ↗

Documentation menu

Getting Started Recipes CLI Python SDK Python SDK API Reference TypeScript SDK TypeScript SDK API Reference MCP Server Model Gateway REST API Reference Editor & CLI Setup OpenClaw Setup Codex & ChatGPT Desktop Setup Claude Code Setup OpenCode Setup POST Discover capabilities POST Inspect capabilities POST Probe a capability POST Call a capability GET Reconcile an uncertain Call GET Get capability details POST Query a capability POST Register an anonymous agent trial POST Claim an anonymous agent trial POST Verify an agent trial claim POST Prepare an Agent trial POST Activate an Agent trial GET Read Agent trial state DELETE End an Agent trial GET Read trial execution readiness POST Quote a trial Call POST Confirm a trial Call GET Recover a trial Call GET Recover a trial claim receipt POST Verify a new trial owner POST Save a trial to a new account POST Save a trial to an existing account POST Start device authorization POST Issue or exchange an OAuth token POST Introspect a resource token POST Revoke an OAuth token GET Query OAuth usage history GET Query OAuth credits ledger POST Verify an API token GET Get authenticated credits GET Get current credits GET Get settlement history GET Get credits spent GET Query usage history GET Summarize usage history GET Export usage history GET Get a usage event GET Query the credits ledger GET Get ledger readiness GET Export the credits ledger GET Get a ledger entry GET Get API metadata GET List providers GET List provider categories Client close discover search_tools inspect get_tools_by_ids probe call reconcile_call execute_tool capability_detail capability_query usage ledger handle_tool_call Agent Configuration Response models CapabilityDetailResponse CapabilityQueryRequest CapabilityQueryResponse CatalogVerification CreditsLedgerItem CreditsLedgerResponse ExecutionRestrictions Message ProbeQuoteResult ProbeRecoveryAdvice ProbeSchemaResult ProbeSchemaViolation ProbeUnknownResult PublicSearchResponse RegionRestrictions SearchResponse StreamEvent ToolCapability ToolCapabilityTag ToolCategory ToolExecutionResponse ToolInfo ToolParameter ToolProbeResponse UsageEventItem UsageHistoryResponse ValidationIssue VerificationCheck ZeroQuoteSettlementReview AgentDelegationCredentialProvider AgentDelegationCredentialProvider — Methods AgentDelegationError AgentDelegationError — Methods ApiKeyCredentialProvider ApiKeyCredentialProvider — Methods Qveris Qveris — Methods QverisApiError QverisApiError — Methods AgentDelegationConstraints AgentDelegationCredentialProviderOptions ApiEnvelope ApiError ApiObservability BillingChargeLine BillingPrice BillingRule CallOptions CapabilityDetailResponse CapabilityQueryResponse CatalogCapability CatalogCapabilityName CatalogVerification CompactBillingStatement CredentialContext CredentialProvider CredentialProvider — Methods CreditsLedgerItem CreditsLedgerRequest CreditsLedgerResponse CreditsResponse DiscoverOptions ExecuteRequest ExecuteResponse ExecuteResultData ExecuteResultFields ExecuteResultProjectedOverflow ExecuteResultRawObject ExecuteResultSummaryBase ExecuteResultTruncated ExecuteTransportOptions ExecutionLookupResponse ExecutionRestrictions GetToolsByIdsRequest InspectOptions NextAction ProbeOptions ProbeQuoteResult ProbeRecoveryAdvice ProbeRequest ProbeResponse ProbeSchemaResult ProbeSchemaViolation ProbeUnknownResult PublicDiscoveryClient PublicDiscoveryClient — Methods PublicInspectOptions QverisAdapterOptions QverisAdapterTool QverisClientConfig RegionRestrictions SearchRequest SearchResponse SearchStats ToolCapability ToolCapabilityTag ToolCategory ToolExamples ToolExecutionReconciliationData ToolInfo ToolParameter ToolStats UsageEventItem UsageEventsResponse UsageHistoryRequest ValidationIssue VerificationCheck ZeroQuoteSettlementReview AgentDelegationErrorCode ApiErrorType ApiOperation CapabilityQueryRequest CredentialPurpose ExecuteResult ExecuteResultSummary JsonValue ProbeCheck ProbeLiveBudget PublicDiscoverOptions PublicDiscoveryClientOptions PublicDiscoveryContext PublicSearchResponse PublicToolInfo QverisClientOptions QverisDefaultTools QverisProbeTools ToolParameterContract VerificationCheckName VerificationStatus getQverisTools()

Methods

getCredential()

getCredential(_context): Promise<string>

Parameters

_context

CredentialContext

Returns

Promise<string>

Implementation of

CredentialProvider.getCredential

Was this page helpful?

PreviousApiKeyCredentialProvider NextQveris

On this page

Methods getCredential()