Ask AI

Ask AI is an assistant built into this portal. It answers questions about the Shiprocket API v1 documentation, such as which API to call, what a field means, or why a request returned an error. Every answer lists the operations and guides it used, so you can check it against the docs.

AI answers can be wrong, so always check the linked docs before you change your integration.

Open Ask AI

• Select Ask AI in the top navigation, or press ⌘/ (Mac) or Ctrl+/ (Windows and Linux). Press the shortcut again to close it.
• The panel opens on the left side of the page. Type your question and press Enter to send it. Press Shift+Enter for a new line.
• Select Stop to stop an answer while it is being written. Select New chat to clear the conversation and start again.

While Ask AI works on an answer, the panel shows what it is doing: searching the API reference, reading an operation, writing the answer, and checking the answer against the docs. Answers usually arrive within 30 seconds.

What Ask AI can and cannot do

Ask AI can:

• find the API for a task, for example the operation that cancels an order or schedules a pickup;
• explain request fields, required fields and documented values;
• explain a documented error message and how to fix the request;
• answer follow-up questions in the same conversation;
• explain a response you got from try-it on the API reference (see Ask about a try-it response).

Ask AI cannot:

• see your account. It has no access to your orders, shipments, AWBs, wallet or any other account data;
• call the Shiprocket API. It never creates, changes or reads anything in your account, and it never runs a request for you;
• answer from outside these docs. It uses only the public v1 documentation on this portal. It does not use other API versions, internal information or general web content.

If a question is not about the Shiprocket API documentation, or Ask AI cannot find a documented answer, it says so instead of guessing: "I can only answer questions about the Shiprocket API documentation."

To act on your account through an AI client, use the Shiprocket MCP Server instead. It uses your own credentials.

Sources in an answer

Each answer ends with a Sources list. A source is one of:

• API — an operation in the API reference. The link opens that operation.
• Guide — a section of a guide on this portal.
• Error — a documented error response of an operation.

Ask AI checks every answer against the docs before showing it. An answer that names an endpoint or operation the docs do not have is corrected or not shown.

Ask good questions

Short, specific questions get the best answers. Name the task, the endpoint or the exact error message.

You can ask in English or in Hinglish. For example:

• "Order cancel karne ke liye kaunsi API use karni hai?"
• "AWB assign karte time 422 kyun aa raha hai?"
• "Label nikalne ke liye kya call karna hoga?"

A few tips:

• Paste the exact error message from the response. Ask AI matches it against the documented errors.
• Ask one thing at a time. Use a follow-up question for the next step.
• Name the endpoint if you know it, for example POST /courier/assign/awb.
• Questions can be up to 2,000 characters long.

Ask about a try-it response

When you run a request with try-it on the API reference, an Ask AI about this response button appears. Select it to open Ask AI with:

• a ready-made question, for example "Why did POST /orders/create/adhoc return 422, and how do I fix it?". You can edit it before you send it;
• the request and response attached, shown as About: POST /orders/create/adhoc → 422 (customer data masked). Select × on it to remove the attachment.

Nothing is sent until you select Send.

Privacy

Your questions, the recent conversation and any masked try-it request and response you attach are processed by Shiprocket's AI gateway and by a third-party AI model provider to write the answer. Do not paste personal data, credentials or tokens into Ask AI. The retention terms for this processing are being finalised and will be published in this guide.

Before anything leaves your browser, Ask AI masks what it sends about a try-it call:

• Headers are dropped. Only Content-Type and Accept are kept. Authorization, cookies and every other header are removed, so your API token is never sent.
• Personal and account data is replaced with placeholders such as <NAME>, <EMAIL>, <PHONE>, <ADDRESS>, <PINCODE>, <GSTIN>, <AWB>, <ORDER_ID> and <SHIPMENT_ID>. Ask AI still knows what kind of value was there, which is enough to explain most errors. Values of password, token and other secret fields become <SECRET>.
• Large requests and responses are shortened to about 6 KB each.

What you type is sent as you wrote it, except that anything that looks like a token is replaced with <TOKEN>. Do not paste tokens, passwords or customer data into your question.

Also:

• Ask AI does not need you to sign in and does not send your sign-in token. Requests are sent without cookies.
• Ask AI sends your question and the last few messages of the conversation, so it can answer follow-up questions.
• Nothing is saved in your browser. The conversation is kept only in the open page and is gone when you reload or close the tab.
• Your IP address is not stored. Ask AI uses a one-way hash of it to apply the limits below.
• Questions that Ask AI could not answer are kept for about two weeks, with digits masked and email addresses removed, so the docs team can fill gaps in the documentation.

Limits

Ask AI is free to use, with limits per network (IP address):

• about 20 questions every 10 minutes;
• about 25 answers per day.

Ask AI may also stop answering for the day when overall daily usage is high. When you reach a limit, the panel shows how long to wait and disables Send until then. Ask AI does not resend your question by itself.

Messages you may see

Feedback

Below each answer, Ask AI asks Was this helpful?

• Select the thumbs-up to say the answer was helpful.
• Select the thumbs-down to tell us what was wrong: Wrong API, Wrong field, Outdated, Unclear or Other. You can add a short note of up to 500 characters. Do not include customer data. Personal data in the note is masked before it is sent.

Feedback is anonymous. It carries only the answer's id, your rating, the reason and the note. It never carries your token, and your IP address is not stored with it. The docs team uses it to correct the documentation and improve Ask AI.

Use the docs in your own AI tools

To use these docs in Claude, ChatGPT, Cursor or another AI tool, see Use the docs with AI agents.