For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
DeveloperAcademyCommunityStatus
ReferenceGuides
ReferenceGuides
  • Agent Studio
    • Overview
    • Quickstart Guides
    • Core Concepts
    • Conversation Process
    • Actions
    • Connectors
      • System Connectors
      • HTTP Connectors
        • Basic Auth
        • API Key Auth
        • Bearer Token Auth
        • OAuth 2.0 - Client Credentials
        • OAuth 2.0 - Authorization Code
        • OAuth 2.0 - JWT Bearer Auth
        • OAuth 2.0 - Refresh Token
        • OAuth 2.0 - Password Credentials
        • JWKS Auth
      • Network Allowlisting
    • System Triggers
    • Agent Architect
    • Cookbooks
    • Development and Testing
    • AI Agent Marketplace
    • Developer Tools
  • Agentic AI
    • LLM Fundamentals
    • The Agentic Reasoning Engine
    • Memory Constructs
    • Conversational Context
    • Guardrails
    • Grounding and Hallucinations
    • Continuous Learning
    • LLMs & SLMs
    • Steerability Tools
    • Multilingual Support
  • Core Platform
    • User Identity
    • Moveworks Agent (On-Prem)
    • Approvals Engine
    • Entity Catalog
    • Moveworks Data Objects
    • Security Information and Event Management (SIEM) Logs Overview
DeveloperAcademyCommunityStatus
On this page
  • Authentication Options
  • API Key in Header
  • API Key in Query Parameter
Agent StudioConnectorsHTTP Connectors

API Key Auth

||View as Markdown|
Was this page helpful?
Edit this page
Previous

Bearer Token Auth

Next
Built with

API Key authentication requires you to send an API key with your request. You can do this in two ways:

Authentication Options

API Key in Header

Your API key will be added to an HTTP Header like this:

$curl -X GET "https://api.example.com/data" \
> -H "Authorization: Bearer YOUR_API_KEY"

To set this up:

  1. Select API Key from the Auth Config dropdown.

  2. Choose Header Auth as the Auth Type.

  3. Fill in these fields:

    Field NameField Value
    Header Auth KeyThe HTTP Header name. Defaults to Authorization
    Header Auth Value PatternA ā€% stringā€ format string. Defaults to Bearer %s
    API KeyThe API key inserted over %s. (YOUR_API_KEY above)

API Key in Query Parameter

Your API key will be added as an HTTP query parameter like this:

$curl -X GET "https://api.example.com/data?API_Key=YOUR_API_KEY"

To set this up:

  1. Select API Key from the Auth Config dropdown.

  2. Choose Param Auth as the Auth Type.

  3. Fill in these fields:

    Field NameField Value
    Param Auth Param NameThe query parameter name associated with your API key. (API_Key above)
    API KeyThe actual API key value itself. (YOUR_API_KEY above)