Altan
Home
DiscordStatus
Home
DiscordStatus
  1. interface
  • What is Altan?
  • Support Options
  • Projects
    • Create Your First Project
    • App Navigation & Settings
    • Building Tips
    • The Art of Prompting
    • Publishing Your App
    • Rollback and Checkpoints
    • Instantly Resolve Errors
    • How to export projects from Altan - Github
    • How to import projects into Altan
    • Work collaboratively
    • Removing Altan's watermark
  • Databases
    • Introduction
    • Import from Supabase
    • Security
    • Technical Overview
    • Database Tools for Agents
  • AI Agents
    • What is an AI Agent?
    • Create your first AI Agent
    • Tools
    • Interacting with Your AI Agent
    • Technical Overview
    • ElevenLabs Voice Integration
    • Altan Frontend SDK
      • Altan Frontend SDK
  • Flows
    • Create your first Flow
    • Automation basics
    • Adding modules
    • Types of modules
    • Passing data
    • Filters
    • Debugging
    • Retrigger events
    • Version History
    • Overwrite connection
    • Task credits
  • Integration
    • Magic Link
    • Altan Integrator
    • Create your integration
  • Authentication
    • Authentication
  • Payments
    • Checkout Session
    • Object Storage
  • Media
    • Media
  • Partner Program
    • Who are our Partners?
    • Partner Program Benefits
    • How to start on Altan
    • Become an Altan Partner
  • API Reference
    • account
      • Create Account
      • Get Account Gq
      • Get Account Public
      • Get Account Usage
      • Patch Account
      • Delete Account
      • Get Account Users
      • Create Custom Webhook
      • Create Media
      • Create Media From Url
      • Create Multiple Media
      • Create Token
      • Create Agent
      • Upsert Flow
      • Fetch User Account Notifications
      • Create Altaner
      • Get Selected Template Version
      • Get Latest Template Version
      • Get Template Version
      • Invite User
      • Create Interface
      • Get Members
      • Get Account Connections
      • Get Apikey
      • Delete Apikey
    • project
      • Get Altaner
      • Create Project V2
      • Update Altaner
      • Delete Altaner
      • Get Altaner Flows
      • Clone Altaner
      • Update Altaner Positions
      • Create Altaner Component
      • Update Altaner Component
      • Get Altaner Component
      • Atomic Update Altaner Component
      • Delete Altaner Component
      • Duplicate Altaner
      • Create Idea
    • interface
      • Start Dev Server
        POST
      • Get Dev Status
        GET
      • Send Dev Error To Agent
        POST
      • Revise Interface
        POST
      • Get Dev Errors
        GET
      • Log Error
        POST
      • Create Or Overwrite File
        POST
      • Update File
        PATCH
      • Create Multiple Files
        POST
      • Read File
        POST
      • Read Multiple Files
        POST
      • Delete File
        POST
      • Rename File
        POST
      • Update Files Pattern
        POST
      • Search In Files
        POST
      • Search And Replace
        POST
      • Preview Updates
        POST
      • Install Libraries
        POST
      • List Tree
        GET
      • List Tree Json
        POST
      • Get Repo Status
        GET
      • List Branches
        GET
      • Create Branch
        POST
      • Delete Branch
        POST
      • Switch Branch
        POST
      • Clone Repo
        POST
      • Merge Branch
        POST
      • Commit Changes
        POST
      • Get Diff Changes
        GET
      • Accept Changes
        POST
      • Discard Changes
        POST
      • Push Changes
        POST
      • Pull Changes
        POST
      • Reset Repo
        POST
      • Get Repo Log
        GET
      • Restore Main
        GET
      • Get Public Interface
        GET
      • Get Interface By Name
        GET
      • Get Interface
        GET
      • Update Interface
        PATCH
      • Delete Interface
        DELETE
      • Get Interface Screenshot
        GET
      • Update Interface With Ai
        POST
      • Publish Interface
        POST
      • Vercel Webhook
        POST
      • Get Deployment Status
        GET
      • Add Collaborator
        POST
      • Get Deployment Logs
        GET
      • Fix Deployment With Ai
        POST
      • Add Domain
        POST
      • Get Domains
        GET
      • Remove Domain
        DELETE
      • Verify Domain
        POST
      • Add Env Variables
        POST
      • Get Env Variables
        GET
      • Delete Env Variable
        DELETE
      • Sync Env Variables
        POST
      • Rollback Deployment
        POST
      • Get Commit Details
        GET
      • Restore To Commit
        POST
    • flows
      • modules
        • Fetch Module
        • Update Flow Module
        • Delete Module
        • Fetch Graph Module
        • Rename Module
        • Update Position In Canvas
        • Update In Edge Filter
        • Update Route Condition Filter
        • Add Condition
        • Get Available Variables For Mappings
      • hooks
        • Get Webhook
        • Update Hook
      • executions
        • Get File Signed Url
        • Stream Execution
      • Fetch Flow Execution
      • Fetch Flow
      • Update Flow
      • Delete Flow
      • Get Latest Execution
      • Fetch Flow Schema
      • Get Flow From Hook
      • Get Flow Hook
      • Fetch Flow Executions
      • Fetch Flow Executions
      • Upsert Flow Module
      • Add Flow Module
      • Create Flow Duplicate
      • Clone Flow Modules
      • Paste Flow Modules
      • Delete Modules
      • Update Edge
    • media
      • Get Media Url
      • Delete Media
      • Get Multiple Media
      • Get 3D Media
      • Delete Model
      • Create 3D Model
    • agents
      • tools
        • Patch Tool
        • Patch Tool
      • authorizaiton requests
        • Create Authorization Request
        • List Authorization Requests
        • Get Authorization Request
        • Delete Authorization Request
        • Reject Authorization Request
      • Get Altan Agents
      • List Voices
      • Get Agent
      • Update Agent
      • Delete Agent
      • Get Agent
      • Create And Add Tool To Agent
      • Remove Tool And Space
      • Get User Agent Dm Room
      • Get Agent Gate
      • Get Agent Member Usage
  • Schemas
    • Schemas
      • AcceptChangesMessage
      • AccountCompanyUpdate
      • AddCollaboratorRequest
      • AddConditionRequest
      • AddGuestToRoomRequest
      • AgentInteraction
      • AgentSecurity
      • AgentToolCreate
      • AltanerComponentAtomicUpdate
      • AltanerComponentModel
      • AltanerComponentType
      • AltanerDuplicate
      • AltanerNew
      • AuthorizationRequestCreate
      • BasicOpGroup
      • BasicOperator
      • Body_clone_repo_interfaces_dev__interface_id__repo_clone_post
      • Body_create_3d_model_media__account_id__models_post
      • Body_delete_file_interfaces_dev__interface_id__files_delete_post
      • Body_merge_branch_interfaces_dev__interface_id__repo_branches_merge_post
      • Body_preview_updates_interfaces_dev__interface_id__files_preview_updates_post
      • Body_rename_file_interfaces_dev__interface_id__files_rename_post
      • Body_update_files_pattern_interfaces_dev__interface_id__files_update_pattern_post
      • CanvasPosition
      • CloneModulesRequest
      • CloneTemplateRequest
      • CommitMessage
      • CreateAPIKey
      • CreateGuestRequest
      • CreateGuestRoomRequest
      • CreateModelConfig
      • CreatePolicy
      • CreateTemplate
      • CreateTemplateVersion
      • DevErrorModel
      • Domain
      • DomainRequest
      • EdgeUpdateRequest
      • EditAgent
      • EditTool
      • EditUser
      • EntityPatch
      • EntityPatches
      • EnvVariable
      • EnvVariablesRequest
      • ErrorData
      • ErrorDetectedBoundary
      • FileCreate
      • FileUpdate
      • FilterSpec
      • FlowCreate
      • FlowModuleCreate
      • FlowModuleCreateOrUpdate
      • FlowModuleUpdate
      • GateModel
      • GraphQuerySpec
      • GroupBySpec
      • HTTPValidationError
      • InstallLibraries
      • InvitationCreate
      • LLMProvider
      • ListTreeJsonRequest
      • LogicalGroup
      • LogicalType
      • MediaCreate
      • MediaUrls
      • MemberRole
      • ModuleFilterMode
      • MultipleMediaCreate
      • NameRequest
      • NewAgent
      • NewInterface
      • NotificationCreate
      • NotificationUpdate
      • OperatorType
      • OrderBySpec
      • PaginateSpec
      • PasswordEdit
      • PasteModulesRequest
      • PatchModelConfig
      • PatternUpdate
      • PrivacyEnum
      • PromptModel
      • ReadMultiRequest
      • ReplaceResponse
      • ReplaceSummary
      • SearchAndReplaceModel
      • SearchMatchDetail
      • SearchQueryModel
      • SearchResponse
      • SearchResult
      • SpacePrivacyEnum
      • Status
      • TemplateEntityType
      • TemplateVersionSettings
      • UpdateForm
      • UpdateGuestRequest
      • UpdateMethod
      • UpdateModuleCanvasPositionRequest
      • UpdateModuleInEdgeRequest
      • UpdateRouteConditionFilterRequest
      • UpdateSpace
      • UpdateTemplate
      • ValidationError
      • VersionTypes
      • VoiceConfig
      • VoiceMetadata
      • WebhookCreate
      • CreateSpace
      • CreateSpace
  1. interface

Get Interface

GET
https://api.altan.ai/interfaces/{interface_id}
Get interface with account information using InterfaceService

Request

Authorization
OAuth 2.0
Password
Add the parameter
Authorization
to Headers，whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Token URL: token
or
API Key
Add parameter in header
X-Altan-Key
Example:
X-Altan-Key: ********************
or
Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.altan.ai/interfaces/'

Responses

🟢200OK
application/json
Successful Response
Bodyapplication/json

Example
null
🟠404Record Not Found
🟠422Parameter Error
Modified at 2025-07-28 15:04:11
Previous
Get Interface By Name
Next
Update Interface
Built with