Laminar
  • Laminar
  • Platform
    • Overview
    • Running an Integration
      • Simple Integration Example
      • Integration with Control Flow Example
    • Integration Design
      • API Requests
      • Data Transformations
      • Control Flow
    • Keywords
      • Requests
      • lam.resolveThenExecute
      • lam.exit
      • lam.execute
      • lam.asyncExecute
      • [DEPRECATED] lam.result
      • lam.httpRequest
      • lam.httpRequests
    • Languages
  • Concepts
    • Workflows
      • Global Workflow Object
      • How to Build
    • Flows
      • Flow Runs
    • API Descriptions
    • Auth Credentials
    • API Key
    • Configurations
    • API
      • Reference
        • Workspaces
          • Issues
          • Users
          • Invitations
            • Decline
            • Accept
            • Received
            • Created
          • Workflows
          • Flows
          • Auth credentials
          • Api keys
          • Api descriptions
        • Workflow
          • Execute
            • External
          • Flows
          • Executions
        • Users
        • Flows
          • Runs
          • Versions
          • Stats
          • Recent runs
          • Read
        • Configurations
          • Properties
          • Flow credentials
          • Workspace
        • Auth credentials
        • Api descriptions
        • Api keys
        • Transform
          • Test
        • Lami
          • Public
          • Direct
        • Auth
          • Signin
          • Register
          • Refresh
          • Me
          • Users
            • Password
    • Changelog
  • External Links
    • Book a Demo
    • Playground
    • Sign In
  • About
  • Specification
  • About
  • Specification
Powered by GitBook
On this page

Was this helpful?

  1. Concepts
  2. API
  3. Reference

Api descriptions

PreviousAuth credentialsNextApi keys

Was this helpful?

post

/api-descriptions

Authorizations
Body
urlstringrequired
authCredentialIdinteger · int64required
workspaceIdinteger · int64required
namestringrequired
descriptionstringrequired
methodTypestring · enumrequired
Options: GET, POST, PUT, DELETE
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.laminar.run/api-descriptions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "text",
    "authCredentialId": 1,
    "workspaceId": 1,
    "name": "text",
    "description": "text",
    "methodType": "GET"
  }'
200
{
  "id": 1,
  "url": "text",
  "authCredentials": {
    "id": 1,
    "name": "text",
    "authType": "text"
  },
  "name": "text",
  "description": "text",
  "methodType": "GET"
}

OK

put

/api-descriptions

Authorizations
Body
apiDescriptionIdinteger · int64required
urlstring
authCredentialIdinteger · int64
namestring
descriptionstring
methodTypestring · enum
Options: GET, POST, PUT, DELETE
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url 'https://api.laminar.run/api-descriptions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "apiDescriptionId": 1,
    "url": "text",
    "authCredentialId": 1,
    "name": "text",
    "description": "text",
    "methodType": "GET"
  }'
200
{
  "id": 1,
  "url": "text",
  "authCredentials": {
    "id": 1,
    "name": "text",
    "authType": "text"
  },
  "name": "text",
  "description": "text",
  "methodType": "GET"
}

OK

get

/api-descriptions/{id}

Authorizations
Path parameters
idinteger · int64required
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.laminar.run/api-descriptions/{id}' \
  --header 'Authorization: Bearer JWT'
200
{
  "id": 1,
  "url": "text",
  "authCredentials": {
    "id": 1,
    "name": "text",
    "authType": "text"
  },
  "name": "text",
  "description": "text",
  "methodType": "GET"
}

OK

delete

/api-descriptions/{id}

Authorizations
Path parameters
idinteger · int64required
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url 'https://api.laminar.run/api-descriptions/{id}' \
  --header 'Authorization: Bearer JWT'
200
No body

OK

  • POST/api-descriptions
  • PUT/api-descriptions
  • GET/api-descriptions/{id}
  • DELETE/api-descriptions/{id}