Qodex.ai

Create an API

POST https://api.getpostman.com/apis

Creates an API. Include the following properties in the api object:

  • name — A string value that contains the API's name.

You can include the following optional properties:

  • summary — A string value that contains a summary of the API.
  • description — A string value that contains the description of the API.

Request Params

KeyDatatypeRequiredDescription
workspacestringOptional. The workspace ID in which to create the API.

If you do not use this parameter, the system creates the API in the "My Workspace" workspace. |

Request Body

{"api"=>{"name"=>"{{apiName}}", "summary"=>"{{apiSummary}}", "description"=>"{{apiDescription}}"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"api":{"createdAt":"2022-06-29T20:46:58.000Z","updatedAt":"2022-06-29T20:46:58.000Z","id":"5360b75f-447e-467c-9299-12fd6c92450d","name":"Test API","summary":"Test API Schema","description":"This is a test API.","createdBy":"12345678","updatedBy":"12345678"}}