# GetPaperIDFromUrl

## Description

Returns the ID of an iPaper, given its url. Can also be used to check whether a url is vacant.

## Parameters

| Name | Value                                                                                           |
| ---- | ----------------------------------------------------------------------------------------------- |
| url  | The URL of the iPaper whose ID should be returned. Url must start with a `/` and end with a `/` |

## Sample Response When iPaper Not Found

```xml
<?xml version="1.0" encoding="utf-8"?>
<result>
  <code><![CDATA[SUCCESS]]></code>
  <message><![CDATA[Paper not found.]]></message>
</result>
```

## Sample Response When iPaper Is Found

```xml
<?xml version="1.0" encoding="utf-8"?>
<result>
  <code><![CDATA[SUCCESS]]></code>
  <message><![CDATA[Paper found.]]></message>
  <data>
    <paper id="1106" />
  </data>
</result>
```

## Return Codes

* SUCCESS
* ERROR


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ipaper.io/flipbook-backend-api/paper/get-paper-id-from-url.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.